COR•REC Alert Item Service Documentation

Alerts are combined into a single display on the Action Card during startup. Each alert can either contain a specific action or serve as a simple notification. This service enables plugins to add alerts to the startup alert display. Each alert is represented by a record that remains active until the user decides it is no longer needed. Each alert item is associated with a single action.


			    Service Name: Action Card Alert



			    Service ID: com.corgroup.bms.accounting.alert#ALERT_ITEM



			    Collaboration Method Keys:

			        public static final String HRCREATOR  = "hrcreator";

			        public static final String HANDLER  =  "handler";

			        public static final String HANDLER_MAP  =  "handler_map";

			        public static final String IDENTIFIER  =  "identifier";

			        public static final String SUB_IDENTIFIER  =  "sub_identifier";

			        public static final String MESSAGE  =  "message";



			    
				Action: CorrecService_I.Create - create an alert entry item.

			        Map:The collaboration map requires the following key/value pairs.

			        The asterisk (*) indicates a required pair. The key IDENTIFIER value must be "acct_alert"


								
					
						
							*HRCREATOR
							Human readable value represents the alerts originator plugin.
						
						
							HANDLER
							null or CorrecService ID. Including a service ID explicitly grants COR•REC Alert the
								right to collaborate with the service.
								When selected from the alert combo its service collaboration method is called with the parameters
								[CorrecService_I.MEMBER, HANDLER_MAP].
								The collaborator method return value may be a Boolean or null anything else is ignored. The Boolean
								condition true = delete alert, false = remove alert.
						
						
							HANDLER_MAP
							 Map is included as the map parameter used in a collaborator call when a HANDLER is
								designated.

						

							*IDENTIFIER
							  acct_alert

						

							SUB_IDENTIFIER
							  May be ignored at this time - but as good form dictates, some meaningful tag may be
								entered.

						

							*MESSAGE
							  Used as the alert combo element description.

*HRCREATOR	Human readable value represents the alerts originator plugin.
HANDLER	null or CorrecService ID. Including a service ID explicitly grants COR•REC Alert the right to collaborate with the service. When selected from the alert combo its service collaboration method is called with the parameters [CorrecService_I.MEMBER, HANDLER_MAP]. The collaborator method return value may be a Boolean or null anything else is ignored. The Boolean condition true = delete alert, false = remove alert.
HANDLER_MAP	Map is included as the map parameter used in a collaborator call when a HANDLER is designated.
*IDENTIFIER	acct_alert
SUB_IDENTIFIER	May be ignored at this time - but as good form dictates, some meaningful tag may be entered.
*MESSAGE	Used as the alert combo element description.