Application Description
Then will show a brief description of the functionalities and properties of the applications that can use in the workflow.
- 1.1 Basic Applications
- 1.1.1 StartActivity
- 1.1.2 Answer
- 1.1.3 setLanguage
- 1.1.4 set
- 1.1.5 GUID
- 1.1.6 SetCDRGuid
- 1.1.7 SetCDRType
- 1.1.8 SetRecordName
- 1.1.9 Read
- 1.1.10 GotoIf
- 1.1.11 SetCDRCampaign
- 1.1.12 Queue
- 1.1 Basic Applications
- 2 Specific Functions
- 2.1 FuncODBC (Hash)
- 2.2 While
Basic Applications
StartActivity
This activity is necessary to give the sart the to flow in the same context will indicate that the flow and extension is performed.
This extension are detailed previously in Workflows Designer v5
Fields:
Context: Indicates the context which the flow is applicated.
Exten: Indicates the extension in which the flow is applied.
Answer
This application answerd the call.
Fields:
Delay: Indicates the delay that applied in the answered time of milliseconds.
setLanguage
The language that it producing the call is stored.
Field:
Language: Indicates the language.
set
It can create variables and assign values one that already exist, this variables can be used in all the flow and can store in the database.
Fields:
Variablename: Indicates the variable name, if the name start with two underscore "__" means that it's global (Ex:__Ani).
Value:Indicates the value that assign to the variable.
GUID
This application generate a unique identifier of the call and assign the value automatically to the variable ${guid}.
SetCDRGuid
To let this value unique (the GUID) in the CDR.
SetCDRType
To assign the CDR type,it can be record (to record the conversation), voicemail(if email mailbox ) or fax (if it incoming fax).
SetRecordName
Assign the identifier to the recording, usually use ${guid}.
Read
This application emits an audio and wait an answer which can store a variable, usually is used to generate menus.
Fields:
Variable: It defined a variable in which the value entered after hearing the audio is saved.
Filename: Contains the name of the playing audio,which it must have been previously uploaded to the portal.
Maxdigits:Tha maximun number of digits that may have the answer is defined.
Option : May 's','i','n'. These options indicate the behavior that can take read in particular cases, the behavior description of each tab in the application help.
GotoIf
This application is used to evaluate conditions, it can be used variables declarated in the SET, returns to the READ and Asterisk variables. Its normal use is after a READ to evaluate the entered option. This application has two outputs:
Green way: When the condition is true.
Red way: When the condition is false.
Fields:
Condition: Write a condition to evaluate.
SetCDRCampaign
To assign the name of the campaign to CDR.
Fields:
Camp: Name of the campaign which turns the call.
Queue
Derives the call to a queue.
Fields:
Queuename: The name of the campaign to derives the call.
Options: Can add options to the call, the description of each option that found the tag of help of the app.
Url: Send a url.
Annonceoverride: Changes the announcement.
Timeout:Maximum time to be in the queue.
AGI: Runs AGI script when the call is attended.
Macro: Runs macro when the call is attended.
Gosub: Go to the sub of rutine.
Rule: Applies to a rule.
Position: Gives a position in the queue.
Specific Functions
FuncODBC (Hash)
Asterisk function that allows to make queries to the data base.
Applied to a workflow, the function will take as its parameter the name of the variable that contains the query to the data base that the user writes.
The Hash function will take all the data from the rows in the data base and makes them more "accessible" for the user to make queries.
This last query will return a row, for example:
HASH(query) = (name, CallerID, Agent, Campaign) → HASH(Result) = (Sophie, 0800, Agent1, Campaign1)
If the user wants to get an specific data from the row, using the example above, the user must use the following:
HASH(Result, name) → "Sophie"
HASH(Result, CallerID) → 0800
HASH(Result, Agent) → Agent1
HASH(Result, Campaign) → Campaign1
Example:
In this example, we can see that the variable that takes as parameter the function Hash, is called Result. To the right, the user wrote the query that the variable Result represents.
The following will return a row containing the consulted data from the columns (did, name, dialstring).
While
The While function consists of a condition and a block of code called an expression. This function checks if the condition is true, if it is, executes the expression. The lasts steps repeat themselves till the condition is false.
Applied to a workflow, for example:
We have the While action, that contains the condition, then it continues with the block of code that gets to be executed if the condition is true, if it is, the block of code executed as long as the condition is true. When this one is false, the workflow will get to the EndWhile action and continue the flow.