Alert

This component allows Alerts to be registered in the Alert console. This is same as invoking alerts from an Action in releases prior to 5.0. You can also consolidate the alerts by grouping the attributes in the YFS_INBOX table.

Configuration properties

The following are the properties of this node:

Table 1. Alert configuration properties
Property Description
General Tab
Alert Queue Name Select the name of the queue alerts should be sent to.
User ID Select the user ID to which the alert is assigned.
Alert Type Enter the type of the alert. The type that is assigned here displays as the Alert Type in the Alert Console and can be used to filter alerts. The type entered is user defined.
Priority Enter the priority of the exception raised.
Description Enter a brief description of the alert raised.
Template Name Enter the XSL Template Name.

The output of the XSL and the incoming XML document merge displays in the description field on the Alert Console. For example, to display OrderNo, the sample XSL is <INSTALL_DIR>/repository/xapi/template/merged/exception_console/sample_exception_console.xsl

When the type of incoming XML is TYPE_JAVA_MAP, to display the OrderNo, the sample XSL is <INSTALL_DIR>/repository/xapi/template/merged/exception_console/sample_keymap_exception_console.xsl.

This XSL is called by the raiseEvent API. For more information about the incoming XML data types, see the Javadoc.
List Template Enter the XSL list template. The output of the XSL and the incoming XML document merge displays on the Alert List and Home Page.
Resolve By (Hrs) Enter the number of hours the alert should be resolved by. The hours can be specified in decimals also, for example 5.5 or 20.
Expiration Days Specify the number of expiration days for the alert after which this exception may be automatically closed. A value of zero means the exception does not expire.
System Arguments Tab
Argument Name Predefined elements available to a particular process repository. The following attributes are optional and can be specified as static or dynamic values. xml:/<ElementName>/@<AttributeName>
Argument Value Static or dynamic values that are specified in the following format: 

xml:/<ElementName>/@<AttributeName>
User Arguments Tab
Reference Name Enter additional name/value data that can be used to add information to the alert.
Reference Value Enter the reference value. This is a static or dynamic values that are specified in the following format: 

xml:/<ElementName>/@<AttributeName>
Reference Type Enter the reference type. Valid values are: TEXT, URL
Consolidation Tab
Consolidation Required Check this box if you wish to consolidate the alerts. A consolidation count is kept to increment similar alerts that follow the same template attributes.

If it is not selected, then the count always remains 1.
Consolidation Template Select either Default or Custom for consolidating the alerts. The default chosen option is Default.

If Custom is chosen, then the attributes for the consolidation template appear below. These attributes are from the YFS_INBOX table and the corresponding XML file can be found in <INSTALL_DIR>/repository/xapi/template/merged/resource/exceptionConsolidation.xml. You can select any of the attributes by right clicking the attribute and including it for consolidation.

If you have extended the columns in YFS_INBOX table, then those attributes appear under the Extn element.
Consolidate Dates By Specify whether the consolidation is done daily or hourly. By default the option is set to Day.

Choosing this option is useful only if you include any time attributes such as Date in the consolidation template.
Routing Tab
Routing Required Check this box, if you want to route the alert based on the routing rules. For more information about defining routing rules, see Section 16.3.3 "Creating an Exception Routing Rule".
Routing Organization Enter the XML path of the organization that owns the alert routing rules.

By default, this field is disabled.
Attribute Name Displays the predefined routing attributes applicable for an alert. You can specify the following predefined routing attributes:
  • BUYER
  • SELLER
  • ENTERPRISE
  • NODE
  • DEPARTMENT CODE
Note: You can also enter your own custom routing attributes.
Attribute XPath Enter the XML path of the routing attribute.

Connection properties

The following are the alert node's connection properties:

Table 2. Alert connection properties
Connection Node Connection Rules
Can be the first node after the start node Only for services invoked synchronously
Can be placed before
  • Any transport node except for FTP or File I/O
  • Any other component node
Can be placed after
  • Start node
  • Any transport node except for FTP or File I/O
  • Any other component node
Passes data unchanged Yes