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)

Parameter

Description

"valueName"

The workflow alarm value name, as defined in the Alarm Detection Editor

value

Any value to be associated with the name

Returns

Nothing

Info

Example - Using dispatchAlarmValue

The following code example displays a situation and syntax useful for the dispatchAlarmValue.

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

...

Parameter

Description

message

A main message appearing in the log

parameterName_n

Name of an optional parameter. If declared, parameterValue_n must be declared as well.

parameterValue_n

Value of an optional parameter. If declared, parameterName_n must be declared as well.

Returns

Nothing

Info

Example - Using logWarning

The following code example logs a warning message, which when displayed in the System Log will look like the following figure:

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

...

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

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

...

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, ...3)

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

...

Sends an email to a configured recipient. In order to operate, the system must have an email remitter and an SMTP mail server defined.

Warning

Warning!

If used within the consume block, make sure that conditional expressions guarantees that this function does not get called for each UDR.

...

Parameter

Description

address

Email address to the recipient on the form: "user@xxx.com"

subject

Text ending up as the email subject

message

Message string ending up as the body of the email

note

Note!

This field will be sent as plain text. For sending in HTML format, refer to the mailNotifyHtml function.

sender

Name or address of the sender of the email

Note

Optional

This field will remain optional only when the attachment field is not populated. Once attachment is populated, the sender field will be a mandatory field.

attachment

A list that will contain one or many attachments to be sent with the email. Each list entry will be the full directory path of the attachment.

Info

Example

"/home/admin/attachments/word.txt"

Returns

Nothing

...

Sends an email in HTML format to a configured recipient. In order to operate, the system must have an email remitter and an SMTP mail server defined.

Warning

Warning!

If used within the consume block, make sure that conditional expressions guarantees that this function does not get called for each UDR.

...

Note!

Supports standard HTML content.

Parameter

Description

address

Email address to the recipient on the form: "user@xxx.com"

subject

Text ending up as the email subject

message

Message string ending up as the body of the email

Info

sender

Name or address of the sender of the email

Note

Optional

This field will remain optional only when the attachment field is not populated. Once attachment is populated, the sender field will be a mandatory field.

attachment

A list that will contain one or many attachments to be sent with the email. Each list entry will be the full directory path of the attachment.

Info

Example

"/home/admin/attachments/word.txt"

Returns

Nothing

...