Route Steps

Action Scripts expose an api that help you interact with the telephone system.

class BaseRouteStep

When you create a new Action Script of type Route Step a default implementation will be created. Your Action Script will be derived from the base class 'BaseRouteStep'.

As Noojee PBX is based on Asterisk its worth understanding that calls are passed into Routing using fast AGI using the Asterisk-Java library.

http://asterisk-java.org/

https://github.com/asterisk-java/asterisk-java

The main way of controlling a call is via AGI commands. You can issue AGI commands by calling the getAgi() method on the BaseRouteStep class.

The base class has a number of other useful methods that make it easy to write a Route script.

The core system ships with a large number of Route Scripts which you can reference as examples.

Building a UI

A Route Step also allows you to build a UI for an end user to configure your specific Route step.

The set of UI components are defined in:

au.com.noojee.actionscript.api.v1.args.*

It is considered good practice to define each of the UI fields as Java fields at the top of you class.

The fields MUST bee added to the list of fields returned by the 'BaseRouteScript:getFields()' method.

Debugging

There are a number of tools available to help you debug your Route Steps.

You can seed your code with call to the inbuilt logger by calls to:

• logger.debug(String);
• logger.info(String);
• logger.warn(String);
• logger.error(String);

To see the log output and to test your Scripts use the 'Logging and Testing' tab availble for each Route Step on the Route page.

To run a test, set the Logging Level, Click the Save button and the Click the Test button.

Logging and Testing

The Logging and Testing panel is Noojee's gift to you. (We aren't afraid to admit that we are almost gods when it comes to this sort of thing.  ).

But seriously, the Logging and Testing console is is really powerful and makes it easy to test Routes in general as well as your Custom Routes scripts.

The logging and testing console allows you to originate a call into a specific route or 'capture' a call into a specific route.

Context

The Route context to originate the call into or capture calls that enter. This works with the Number to Dial to define the complete target. (i.e. you can have the same Target

Target

You can enter a phone number or more commonly a Route 'Target' that you want to dial into for testing.

Originating a call (Dial Button)

When building a new Route or Route Script you will want to use the 'Dial' button to originate calls into you route.

The 'Dial' button rings you handset (you MUST have entered a valid extension no. when you logged into Noojee).

When you answer the call the route selected in 'Number to Dial' is run.

Any log output is sent to the Logging and Testing console.

System Route Variables:

Routes provide a number of default system variables which can be access to determine information pertaining to the current call or the system as a whole. The following variables can be access by calling getVariable(variableName).

Please note that these variables are readonly and as such you can't update them.

The system may update some of these Route Variables as a call progresses through a route.

Target

A Target can be a phone no., a pattern or an alphabetical literal.
A Target pattern is a used to match Targets consisting of digits only.

SourceNo

Set by core routing each time a call is originated. For inbound this is the caller id, for calls dialed from a handset this is the handset extension no.

DialedNo

- called by the core routing logic when a call first enters the system. Normally this wouldn't be modified by a script unless the trunk provider provides a badly formatted no. hin which you may want to re-reformat it using the rewrite action.

For most systems the dialed no. doesn't change during the life of a call.

setCurrentTarget(target)

Called by the core routing logic whenever a call matches a route target including when the call enters the very first route.

The routed no is essentially updated each time the call transition into a new route Target (the Gosub step is the main method of changing the current Target).

Documentation

The Action Script UI contains builtin  documentation. Click the 'Open Java Docs' button and a new browser tab will open with the full docs.

BaseScriptRoute

The following provides a high level overview of the BaseScriptRoutes. Refer to the above noted Java doc for additiona details.

Overview: