Introduction

Open

The Integra Designer is the IDE (Integrated Development   Environment) to develop call flows.

With this tool is possible to build DialPlan flows, this flows tells the system how an incoming or outgoing call should behave.

This web tool is developed in HTML5 and JavaScript, is a drag and drop application, each activity is a dialplan application and it's possible to change the application behavior via its properties. The application generates the code needed to be deployed on the server, and it also deploys and loads the call flows directly to and from the server.

Once a flow is deployed, it gets activated immediately.

Every DSN, Audio, Queue, etc. created on the Administrator Portal, will be visible for the dialplan designer and those will be suggested by the system to be selected as options for the properties. You can also load and deploy dialplan flows, once a dialplan is loaded it will get the edition mode active, so every change made on edition mode, will be committed on the deploy and be active immediately.

Visualisation Path Helper: For a better understanding of the application path if you select a connection the color will turn to Light Green if is the default path, if is not, then the color would be red, this helps to check the flows easily.

At the bottom of the Page we have the mode that is active, for new workflows or if you are editing a workflows.

Basics

The basic toolbar is there for basic operations

New: Crreates a new flow (will lose all changes that were not saved).

Open: Looads an JSON saved file.

Save: Saaves as an JSON file the flow.

Undo: To undo the last action.

Redo:To redo the actions you undid.

Copy: To copy the selected portion of the draw (is possible to copy and paste in different Browser tabs).

Paste:To paste any part or application copied or cut (this includes connections and properties)

Remove: To permanently delete them. You can also use the standard Ctrl V, C, X.

Zoom In: To zoom in the view.

Zoom Out: To zoom out the view.

Lock: To lock in place the selected portion of the draw. 

Group: This is useful when we have many items and they are overlapped, so we can manage their position, for editing or moving them.

Align: These are basic tools to get the draw looks the way we want.

Find on diagram: Finds an item on the diagram. The items that matches the search will appear with its name on red.

Deploy, Load and Debug:

These buttons are the basic actions of the designer, we have 2 for dialplan operations, Deploy and Load, and we also have an option for debugging purposes (we can check the generated code in the console).

Selecting an item

Open

Allows to see and edit the properties of the selected item.

Allows to create a connection from one item to another. To draw the connection click             and drag. 

Creates a copy of the selected item.

Shows the description of the application, this is very useful for documentation purposes.

Properties

Extensions 

An extension can be one of two types: a literal or a pattern (do not confuse with telephone extensions). 

A literal extension can be a number, like 123, or characters as_1234.

Special extensions: 

i: Used when dialling an unknown extension in a context or unknown input in an IVR menus.

s: Used for marks and analog lines, is when or numbers or letters does not came.

h: Runs at the end when a call is cut before the number is saved in the system, can set some variables according the result o runs more activities.

t: When it delay typing something while  a reproduction of an audio .

T: Global like the previous one.

Patterns 

Examples 

Do not use a pattern of _. Instead use something like _X. or _X which will not match special extensions. 

Ok, so a "context" has a name, such as "john". And in each context, you can define one or more "extensions". For each extension, you define a set of commands that are the ones that are done via the designer. 

The context and extension are defined in the StartActivity, it's the main activity of flows initation, the contexts are asociated with Agents o Providers.

Flow Managment

Load

This window is for loading diaplan flows, this flows are grouped into contexts, and inside the contexts in extensions.

All calls originating form a device will look for flows that map against extensions that exist in context, if you mapped an extension of that flow steps are executed.  All flows together are the system dial plan.

In controls all calls that pass through the system. The entire system behavior, and there are standar flows that make easier the settings are configured.

Deploy

This Window is activated of a flow and a description is added for then know what to do, once completed its begins to take the systems changes.

If you load a flow to activate we will suggest the previous comment.

Save to Disk

It is possible to save in disk a file of flows if it requires then activate in another server or installation.

Activities

All Activities are documented in the designer itself using the ? icon.