The following functions are used for debugging APL code, or logging user defined messages and events.

The following functions for Log and Notification described here are:

debug

Prints the supplied argument to the output target specified in the Execution tab of the Workflow Properties dialog. Valid options are Event or File . If File is selected, the debug is saved in the temporary directory as stated in the system property pico.tmpdir. The file is to be called debug/<workflow name>. Each time the workflow is activated resulting in new debug information being written, the existing file is overwritten. If Event is selected, the output is shown in the Workflow Monitor.

void debug( arg )

The function makes it possible to detect alarm situations based on workflow behavior. It dispatches a user defined <value> with a user defined valueName from the workflow. The valueName used must be defined using Alarm Detection. For further information, see Alarm Detection in the Desktop user's guide.

void dispatchAlarmValue(string <"valueName">, long value)

consume {
 if ( timeToPay ) {
 udrRoute(chargingUdr, "to_billing");
 //Enable for 'amount out of range' Alarm Detection
 dispatchAlarmValue("chargingAmount", chargingUdr.amount);
 }
}

A user can define a customized event type. This is done using an event UDR, optionally extended with user defined fields. This event UDR can be populated with any information by utilizing APL code, and then be sent on, using the dispatchEvent function, to be caught by the Event Notification. For further information about Event Notification, see Event Notifications in the Desktop user's guide.

void dispatchEvent( UltraEvent  eventUDR )

This method is used to produce user defined messages associated to predefined Event Categories. For further information about the Event Notification editor, see Event Notifications in the Desktop user's guide. For instance, an Event Category could be named 'DISASTER', and be configured to send an email to the System Administrator. Then an APL agent could send a detailed description with the dispatchMessage function whenever this error situation is detected.

void dispatchMessage
 ( string  string , 
 string  <Event Category>  )

Logs a message string to the System Log of type error, warning or information. The entry will fall under the Workflow category where workflow name will be the name of the current workflow and agent name will be the name of the agent logging the message.

void logError
 ( string  message , 
 string  parameterName_n , // Optional
 string|int  parameterValue_n , // Optional
 ... )
 
void logInformation
 ( string  message , 
 string  parameterName_n , // Optional
 string|int  parameterValue_n , // Optional
 ... )
 
void logWarning
 ( string  message , 
 string  parameterName_n , // Optional
 string|int  parameterValue_n , // Optional
 ... )

logWarning( "UDR failed validation",
 "ANUMBER IS ", input.anum, 
 "BNUMBER IS ", input.bnum,
 "DURATION IS ", input.duration);

log.*

These functions invokes logging with log4j. For information about how to configure the logging, such as to set the log level, see the System Administrator's Guide.

void log.fatal
(any message, 
any tag ) //optional

void log.error
(any message, 
any tag ) //optional

void log.warn
(any message, 
any tag ) //optional

void log.info 
(any message, 
any tag ) //optional

void log.debug 
(any message, 
any tag ) //optional

void log.trace
(any message, 
any tag ) //optional

consume {
   log.debug("In consume.");
  list<int> rcDebug =listCreate(int);
 int rc=0;
 listAdd(rcDebug,rc);
 rc=1;
 listAdd(rcDebug,rc);
 log.debug(rc,rcDebug);
 }

mailNotify

Sends an email to a configured recipient. In order to operate, the system must have an email remitter and an SMTP mail server defined. For further information on Platform properties, see Platform in the System Administrator's Guide.

void mailNotify
 ( string  address ,
 string  subject ,
 string  message ,
 string  sender ,  //Optional
 list<string>  attachment  ) //Optional

attachment