Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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(4.23).

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

...

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 Notification(4.23).

Code Block
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 Notification(4.23). 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.

...

These functions invokes logging with log4j. For information about how to configure the logging, see Customizing APL Logging for ECDs (4.2).

...

)

...

Parameter

...

Description

...

A value that will be appear in the message field in the log output
This parameter will be ignored if cannot be typecasted to a primitive data type e g string or int.

...

tag

...

Objects(s) that will appear in the tag field in the log output.

...

Returns

...

Nothing

Info

Example - Using log.debug

Code Block
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);
 }

log.*

These functions invokes logging with log4j. For information about how to configure the logging, ...

Code Block
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

Parameter

Description

message

A value that will be appear in the message field in the log output
This parameter will be ignored if cannot be typecasted to a primitive data type e g string or int.

tag

Objects(s) that will appear in the tag field in the log output.

Returns

Nothing

Info

Example - Using log.debug

Code Block
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);
 }

...