You are here: Business Rules > Attached Rules > TransactionCosmetics

TransactionCosmetics

Description

This rule controls the graphics for the icons and buttons of the activity to which it is associated. As with the TransactionBusinessRulePacket business rule, this rule should be attached (overridden) to all the transactions.

This rule can also be used for the following:

To display a value from the transaction's XML, on the Activity screen.
To alert users for the delete, recycle and reverse button click actions.

TransactionCosmetics Element/Attribute Table
Element/Tag	Definition	Attribute	Element/Attribute Value and Description
<TransactionCosmetics>	Required element; The opening and closing tag of the TransactionCosmetics business rule.
<Icon>	Required element; The icons help users quickly recognize activities. <Icon>tag is used to mention the icon graphic name (.GIF) the activity should be displayed with in the Activity screen. When moving the mouse over the icon next to the activity, a short description of the activity (Processed By, Active From Date, etc.) will be displayed. Clicking the icon will provide much more detailed information on that activity. If the <Icon>tag is not configured in TransactionCosmetics business rule, a red "X" mark (unavailability of the icon image) will be displayed instead of the icon on the left side of the activity (activity icon) in the Activity screen. The functionality of the icon will remain the same.		String; Required element value; Defines the icon name (.GIF). Example: `<Icon>AsIconIssue.GIF</Icon>`
<Button>	Required element; This tag is used to mention the button graphic name (.GIF) that should be displayed in the Activity Details and Activity Results windows. The button will be displayed on the top left corner of the Activity Details and Activity Results windows. If this tag is not configured in the TransactionCosmetics business rule, a red X mark (unavailability of the button image) will be displayed instead of the button .GIF image on the top left corner of the Activity Details and Activity Results windows. Note: Even though it is called a button, it is displayed in the same manner as an icon.		String; Required element value; Defines the button name (.GIF). Example: `<Button>AsButtonIssue.GIF</Button>`
<Reverse>	Required element; This tag is used to mention the name of the image the Reversed/Recycled activities (i.e. the activities in pending/reversal status) should be displayed with on the Activity screen. If this tag is not configured in TransactionCosmetics business rule, a red X mark (unavailability of the image) will be displayed in the place of the Reverse image on the left side of the reversed/recycled activities on the Activity screen.		String; Required element value; Defines the reverse name (.GIF). Example: `<Reverse>AsReverseIssue.GIF</Reverse>`
<Quote>	Optional element; This tag is used to mention the name of the image that should be displayed with the Quote button in the Activity Details window. If this tag is not configured in TransactionCosmetics business rule, Quote button will be displayed as any other regular button instead of an image.		String; Element value; Defines the quote icon name (.GIF) Example: `<Quote>AsQuoteIssue.GIF</Quote>`.
<AmountField>	Optional element;Using the <AmountField> tag, an amount from the transaction can be displayed on the Activity screen => Activity grid.	TOOLTIP	Element value; Pre defined ActivityField or MathVariable from the transaction. Example: `<AmountField>GrossAmount</AmountField>`
<DetailField>	Optional element; DetailField is used to provide non-numeric (anount) information in the Amount/Detail column of the Activity Screen =>Activity grid. Note:If "AmountField" tab exists along with "DetailField" tag in Transaction Cosmetics, "AmountField" will take precedence over "DetailField."	TOOLTIP	Element value; ActivtyField or MathVariable from the transaction. Example: `<DetailField><PremiumType</DetailField>` String; Optional attribute; This attribute is used to provide additional information (default or user-defined configurable tool tip message) on the value that is being displayed. Information is displayed when the user moves the mouse over the value.
<Warnings>	Optional element; <Warnings> tag is used to define the warning messages. This is to alert users about inadvertently deleting a pending Activity or reversing/recycling an active Activity. Note: Warning messages are optional, may exist at the Screen Rule level or at the Transaction Cosmetics Rule . Warning messages configured at the TransactionCosmentics level take priority over those at the Screen Rule level. If Warning messages are not configured at both levels, no warning messages are displayed when the user Deletes, Recycles or Reverses a transaction.
<DeleteWarning>	This tag is used to define the Warning messages that are to be displayed, when the User clicks the Delete icon (trash can) of a Pending activity. This is to prevent the user from inadvertently deleting a pending Activity.		Text; Optional element Value; Element value to control the display of error message by using "Yes" & "No". Yes - If the tag value is set to "Yes", the default/specified warning will be displayed with 'Ok' & 'Cancel' buttons. Upon clicking on the Ok button the activity can be deleted and upon clicking on Cancel button activity can not be deleted and displays the activity on the activity screen as normal. No - If the tag value is set to "No" the warning will not be displayed.
<DeleteWarning>		MESSAGE	String; Optional attribute; Can be used to specify the Warning message upon deleting the activity. A specified warning message displays upon clicking on the trashcan icon when MESSAGE attribute is defined. The MESSAGE attribute is not present or is an empty string, the default message is displayed as "Are you sure?"
<ReverseWarning>	This tag is used to define the Warning messages that are to be displayed, when the User clicks the Reverse icon (trash can) of an Active activity. This is to prevent the user from inadvertently deleting a pending Activity.		Text; Optional element Value; Element value to control the display of error message by using "Yes" & "No". Yes - If the tag value is set to "Yes", the default/specified warning will be displayed with 'Ok' & 'Cancel' buttons. Upon clicking on the Ok button the activity can be reversed and upon clicking on reverse button activity can not be reversed and displays the activity on the activity screen as normal. No - If the tag value is set to "No" the warning will not be displayed.
<ReverseWarning>		MESSAGE	String; Optional attribute; Can be used to specify the Warning message upon deleting the activity. A specified warning message displays upon clicking on the trashcan icon when MESSAGE attribute is defined. The MESSAGE attribute is not present or is an empty string, the default message is displayed as "Are you sure?"
<RecycleWarning>	This tag is used to define the Warning messages that are to be displayed, when the User clicks the Recycle icon of an Active activity. This is to prevent the user from inadvertently recycling an active Activity.		Text; Optional element Value; Element value to control the display of error message by using "Yes" & "No". Yes - If the tag value is set to "Yes", the default/specified warning will be displayed with 'Ok' & 'Cancel' buttons. Upon clicking on the Ok button the activity can be recycled and upon clicking on Cancel button activity can not be recycled and displays the activity on the activity screen as normal. No - If the tag value is set to "No" the warning will not be displayed.
<RecycleWarning>		MESSAGE	String; Optional attribute; Can be used to specify the Warning message upon deleting the activity. A specified warning message displays upon clicking on the recycle button when MESSAGE attribute is defined. The MESSAGE attribute is not present or is an empty string, the default message is displayed as "Are you sure?"

XML Example

<TransactionCosmetics>

<Icon>AsIconIssue.GIF</Icon>

<Button>AsButtonIssue.GIF</Button>

<Reverse>recycleIcon.GIF</Reverse>

<AmountField>TotalBaseFace</AmountField>

</TransactionCosmetics>

Schema Example

<TransactionCosmetics>		
	<Icon>[String]</Icon>	
	<Button>[String]</Button>	
	<Reverse>[String]</Reverse>	
	<Quote>[String]</Quote>	
	<AmountField TOOLTIP="[String]">[String]</AmountField>	
	<DetailField TOOLTIP="[String]">[String]</DetailField>	
	<Warnings>	
		<DeleteWarning MESSAGE="[String]">[No|Yes]</DeleteWarning>
		<ReverseWarning MESSAGE="[String]">[No|Yes]</ReverseWarning>
		<RecycleWarning MESSAGE="[String]">[No|Yes]</RecycleWarning>
	</Warnings>	
</TransactionCosmetics>