Schema aml.xsd

schema location:	C:\dragonflow\current\modules\aml\Aml.Schema\aml.xsd

Elements	Groups	Complex types	Attr. groups
Ai	ContentElements	MixedValue	BindingModel
Collection	DoAuthCommands	TextProcessorType	ClauseID
Contains	DoChild		DisableClause
Count	DoChildren		Distance
CrLf	DoParseChild		DoCommonFormating
Cs	DoParseChildren		DoProperties
CsParse	DoStackCommands		FlexListTokenAttributes
CsRequire	DoUnusedCommands		Keep
CsScript	DoVariablesCommands		Mask
Database	OutputChildren		MaskBegin
DataSource	ParseChild		MaskEnd
Delete	ParseChildren		MaskLike
DeleteAll	ParseTerminators		MatchTolerance
Do	PreTestChildren		MatchType
elementID_Hide	TextProcessor_Filters		Private
Error	TextProcessor_Tokenizer		Sense
Exists			StopWordsFilterCommon
Fit_Begin_Hide			Top
Fit_End_Hide			words
FloatComp			words_bind
IfBlock			words_language
IntComp
Interaction
IsEmpty
Items
List
Match
Math
NBSpace
Output
Parse_Child_Hide
Parse_Inline_Hide
Parse_Pattern_Hide
Parse_Trim_Hide
ParseALL_Child2_Hide
ParseALL_Terminator_Child2_Hide
ParseBest
ParseBest_Terminator_Hide
ParsePermutations
Pattern
Prompt
Replace
Require
Resource
Root
Rule
Secret
Set
Sp
StrComp
Terminator_Hide
TerminatorChar_Hide
Trace
Trim
UseDefine
VBNet
VBNetParse
VBNetRequire
View
Weight
Write

element Ai

diagram
children	Extract LlmRag LlmRagClear InternalUse LlmQuery LlmInit

element Ai/Extract

diagram
children	Content Items Options

element Ai/Extract/Content

diagram
children	Text

element Ai/Extract/Content/Text

diagram

children

Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

element Ai/Extract/Items

diagram
children	Item

element Ai/Extract/Items/Item

diagram
children	Name Unit Assign

element Ai/Extract/Items/Item/Name

diagram

children

element Ai/Extract/Items/Item/Unit

diagram

children

element Ai/Extract/Items/Item/Assign

diagram

children

element Ai/Extract/Options

diagram
children	ClearBefore

element Ai/Extract/Options/ClearBefore

diagram

children

element Ai/LlmRag

diagram
children	Key Query Site Format Assign

element Ai/LlmRag/Key

diagram

children

element Ai/LlmRag/Query

diagram

children

element Ai/LlmRag/Site

diagram

children

element Ai/LlmRag/Format

diagram

children

element Ai/LlmRag/Assign

diagram

children

element Ai/LlmRagClear

diagram
children	Key

element Ai/LlmRagClear/Key

diagram

children

element Ai/InternalUse

diagram

children

Ai_Extract Ai_LlmRagClear Ai_LlmRag Ai_LlmQuery Ai_LlmInit

annotation

appInfo	true
documentation	For internal use, each output child has a direct replacement to skip the "output" level

element Ai/InternalUse/Ai_Extract

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element Ai/InternalUse/Ai_LlmRagClear

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element Ai/InternalUse/Ai_LlmRag

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element Ai/InternalUse/Ai_LlmQuery

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element Ai/InternalUse/Ai_LlmInit

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element Ai/LlmQuery

diagram
children	Content Assign Key Attachments

element Ai/LlmQuery/Content

diagram

children

element Ai/LlmQuery/Assign

diagram

children

element Ai/LlmQuery/Key

diagram

children

element Ai/LlmQuery/Attachments

diagram
children	Resource

element Ai/LlmQuery/Attachments/Resource

diagram
children	Name

element Ai/LlmQuery/Attachments/Resource/Name

diagram

children

element Ai/LlmInit

diagram
children	Key Content

element Ai/LlmInit/Key

diagram

children

element Ai/LlmInit/Content

Pattern Rule Database List Collection Interaction

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	xs:string	optional

element Contains

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language

annotation

documentation	Checks if one of the child elements are contained anywhere in the string
appInfo	Checks if one of the child elements are contained anywhere in the string

documentation	Counts the child variables of the specified variable node. For example, if the variables map is: /temp/a/dog = "Pluto" /temp/a/cat = "Tom" Then <count>/temp/a</count> will return 2
appInfo	count
appInfo	Counts the child variables of the specified variable node.
appInfo	true
appInfo	Variables
appInfo	true

element CrLf

diagram

type

restriction of xs:string

annotation

documentation	Generates a carriage return and line feed at selected output.
appInfo	Append a new-line instruction to the output buffer
appInfo	crlf
appInfo	true
appInfo	Format

Name	Type	Use	Default	Fixed	Annotation
FunctionName	xs:string	optional

annotation

appInfo

cs

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

annotation

appInfo

cs

Name	Type	Use	Default	Fixed	Annotation
FunctionName	xs:string	optional

annotation

appInfo

cs

element CsScript

diagram
children	Code

element CsScript/Code

diagram
type	csScript

documentation	Used to hold the path of the clause in the compiler
appInfo	true

Name

xs:string

required

documentation	A mandatory name for referencing this database connection.
appInfo	A mandatory name for referencing this database connection
appInfo	name
appInfo	true

documentation	Specifies if the item is private, that is, only clauses from the same file may reference it.
appInfo	true
appInfo	private
appInfo	Specifies if the item is private, that is, only clauses from the same file may reference it.

documentation	Defines if the clause will be compiled
appInfo	true
appInfo	disabled
appInfo	Prevents the item to be compiled

Instruct the compiler how to handle unreferenced item (e.g. data base connection) 'always' will keep the clause even if it is not referenced anywhere else. Use this when you reference clause by name like accessing connection by name.

annotation

documentation	Database clause defines a database connection, with its name, location and where the security information of the database is stored. In other elements the databases are referred to by the name of the database connection.
appInfo	true
appInfo	Defines a database connection
appInfo	database

element Database/ConnectionString

documentation	Database connection is created using ADO connection string. Connection string includes a list of parameters that define the location, type and login information for a database.
appInfo	connectionstring
appInfo	defines ADO connection string
appInfo	true

element Database/ConnectionString/Parameter

documentation	Specifies a parameter in the connection string, a parameter is made from a name and a value.
appInfo	Specify a parameter in the connection string.
appInfo	field
appInfo	true

element Database/ConnectionString/Parameter/Name

diagram

children

annotation

documentation	* Provider= Specifies the name of a provider to use for the connection. * File Name= Specifies the name of a provider-specific file (for example, a persisted data source object) containing preset connection information. * Remote Provider= Specifies the name of a provider to use when opening a client-side connection. (Remote Data Service only.) * Remote Server= Specifies the path name of the server to use when opening a client-side connection. (Remote Data Service only.) * URL= Specifies the connection string as an absolute URL identifying a resource, such as a file or directory. For more information refer to Microsoft ADO connection string documentation.
appInfo	Specifies the name of a specific connection parameter
appInfo	name
appInfo	true

element Database/ConnectionString/Parameter/Value

diagram

children

annotation

documentation	Value of the specified parameter
appInfo	Value of the specified parameter
appInfo	value
appInfo	true

documentation	Used to hold the path of the clause in the compiler
appInfo	true

element DataSource/Source

diagram

children

DataSet DatabaseSQL Json DataSource Excel

annotation

documentation	Defines a value list based on a database table or view. The value list can be cached directly into memory or remain in the database imported as a dynaset.
appInfo	Insert a list based on database table or query
appInfo	database_table
appInfo	true

element DataSource/Source/DataSet

Name	Type	Use	Default	Fixed	Annotation
ItemsSeparator	xs:string

annotation

documentation

VLIST is a definition of a dictionary made from keys and values where one value may have several keys.The VLIST enables defining each value and key by using the DO elements.VLIST enables caching the values and keys for increased performance or to dynamically generate the values and keys as needed caching is set using the CACHE child element.

element DataSource/Source/DataSet/Column

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	xs:Name

element DataSource/Source/DataSet/Row

diagram

children

annotation

documentation	Row for the data source, separate values by comma, or the separator defined in the dataset element
appInfo	entry
appInfo	A single entry in a list, made from a set of one or more keys and a value
appInfo	true

element DataSource/Source/DatabaseSQL

documentation	Name of the connection to use in this database index list
appInfo	database_index
appInfo	true
appInfo	Name of the connection to use in this database index list

annotation

documentation

Generate a data source based on the SQL, the column names are the names from the SQL

element DataSource/Source/DatabaseSQL/SQL

documentation	SQL to use, must be a select SQL
appInfo	sql
appInfo	true
appInfo	SQL

element DataSource/Source/Json

use JSON for a normal content "{xx: [{'id':'2',...},{...}...]}"
use ARRAY in case the json provided root is an array so it looks like "[{'id':'2',...},{...}...]"

element DataSource/Source/Json/Source

diagram
children	FileName Http

element DataSource/Source/Json/Source/FileName

diagram

children

element DataSource/Source/Json/Source/Http

diagram
children	Url Verb Timeout Authentication

element DataSource/Source/Json/Source/Http/Url

diagram

children

element DataSource/Source/Json/Source/Http/Verb

diagram

children

annotation

documentation	HTTP verb: get, post...
appInfo	HTTP verb: get, post...

element DataSource/Source/Json/Source/Http/Timeout

diagram

children

annotation

documentation	Timeout in milliseconds
appInfo	Timeout in milliseconds

element DataSource/Source/Json/Source/Http/Authentication

diagram
children	None UserCredentials

element DataSource/Source/Json/Source/Http/Authentication/None

diagram

element DataSource/Source/Json/Source/Http/Authentication/UserCredentials

diagram

element DataSource/Source/Json/JsonPath

a JsonPath for a set of objects
http://goessner.net/articles/JsonPath/
https://support.smartbear.com/alertsite/docs/monitors/api/endpoint/jsonpath.html. For example $.channel.item[*] all the objects in item array

element DataSource/Source/DataSource

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	xs:Name	required

annotation

documentation

Allow to use another datasource as input to this DataSource. for example use this to join DS across files

element DataSource/Source/Excel

diagram
children	FileName SheetName

element DataSource/Source/Excel/FileName

diagram

children

element DataSource/Source/Excel/SheetName

documentation	Deletes a variable. Unlike setting the variable to empty, delete removes the variable from the variables list.
appInfo	deletevar
appInfo	Deletes a variable
appInfo	true
appInfo	Variables

documentation	Deletes a variable. Unlike setting the variable to empty, delete removes the variable from the variables list.
appInfo	deletevar
appInfo	Deletes a variable
appInfo	true
appInfo	Variables

documentation	'do' element has several meanings: 1) 'do' acts as the RHS part of patterns. It contains all the executable action to be taken by the pattern. 2) When used inside another 'do', it simply acts as a container for a set of elements. When called it will call all of it's child elements disregarding the return status of those elements. 3) When used inside 'parse', it must be the last element in the parse, 'do' can be used to make more tests over bounded variables. If any of it's child elements will fail, it will fail the 'parse' element itself. However it will allways execute all of it's child elements.
appInfo	Execute a list of actions.
appInfo	do
appInfo	true

element elementID_Hide

diagram

annotation

documentation	!!!!!! hidden element !!!!!!!!!!!!!!!!
appInfo	false

element Error

diagram

children

description number clear raise

annotation

documentation	Envelope for Error object. The error object is filled on error and it includes textual description, numeric id and methods to clear and to raise errors
appInfo	error
appInfo	true
appInfo	Access error information

element Error/description

diagram

type

restriction of xs:string

annotation

documentation	Returns the description of the error generated; the output is a textual description.
appInfo	error_description
appInfo	true
appInfo	Retuns textual description of the error.

element Error/number

diagram

type

restriction of xs:string

annotation

documentation	Returns the last known error number.
appInfo	Returns the last known error number
appInfo	true
appInfo	error_number

element Error/clear

diagram

type

restriction of xs:string

annotation

documentation	Clears the error object. After an error is raised, the error object contains the error details. It continues to do so until the pattern is completely executed. 'Clear' empties the error object.
appInfo	Clears the error object
appInfo	true
appInfo	error_clear

element Error/raise

diagram

type

restriction of xs:string

annotation

documentation	Raises an error. Use this element to simulate an error in an element execution. The error details include the error number, description and source.
appInfo	error_raise
appInfo	Rases an error
appInfo	true

documentation	Checks if a variable exists in the current context (profile, session and temp).
appInfo	exists
appInfo	Checks if a variable exists in the current context (profile, session and temp).
appInfo	true
appInfo	Variables

element Fit_Begin_Hide

diagram

annotation

documentation	!!!!!! hidden element !!!!!!!!!!!!!!!!
appInfo	false

element Fit_End_Hide

diagram

annotation

documentation	!!!!!! hidden element !!!!!!!!!!!!!!!!
appInfo	false

Name	Type	Use	Default	Fixed	Annotation
Operator	xs:string	required

annotation

documentation	Compares between two given numbers according to a given operator (Equal, LessThan, GreaterThan, LessThanEqual, GreterThanEqual).
documentation	Compares between two given numbers according to a given operator.
appInfo	numcomp
appInfo	Compares between two given numbersf
appInfo	true
appInfo	Math

documentation	IF enables to build a IF THEN [ELSEIF] [ELSE] flow block. The first child is the If, if it's first child returns true the next child are excecuted if false then the next sibling of the If is checked. If siblings can be ELSEIF that is an alternative IF or ELSE that provides a default.
appInfo	ifblock
appInfo	true
appInfo	IF enables to build a simple IF THEN ELSE flow block.
appInfo	Flow

documentation	IF has two children, the first is the condition, if it's true then the next child is executed and the system exits the IfBlock. If the first child returns false the next sibling in the IfBlock is tested.
appInfo	if
appInfo	true
appInfo	The IF-THEN part of the IF block
appInfo	Flow

element IfBlock/ElseIf

diagram

children

annotation

documentation	ELSEIF has two children, the first is the condition, if it's true then the next child is executed and the system exits the IfBlock. If the first child returns false the next sibling in the IfBlock is tested.
appInfo	elseif
appInfo	true
appInfo	The ELSEIF-THEN part of the IF block
appInfo	Flow

appInfo	else
appInfo	Flow
appInfo	true

Name	Type	Use	Default	Fixed	Annotation
Operator	xs:string	required

element Interaction

diagram

children

Require Prompt Response

documentation	Used to hold the path of the clause in the compiler
appInfo	true

do we need to lock the subject (if specified) true lock the subject when entering the interaction, false do not lock, auto lock and release the subject based on the type of tries (e.g. 'free' or numbers will lock the subject locally), local locks the subject (only if there are tries) and automatically release when exiting the interaction

element Interaction/Prompt

prompt

element Interaction/Response

diagram
children	Try Fallback GiveUp

element Interaction/Response/Try

diagram

children

Match Parse Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

If we expect some baseform to be generated between the input and the 'try' then keys may be used (e.g. we requested the user for date and we use patters to preprocess and get some baseform from there)

element Interaction/Response/Try/Parse

diagram
children	Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language Do

element Interaction/Response/Fallback

diagram

children

element Interaction/Response/GiveUp

extension of VariableName

documentation	Checks if an existing variable has no content (equals NULL). Return values: * If the variable exists and has no value the element will succeed. * If the variable exists and has a value the element will fail. * If the variable does not exists then the element will fail.
appInfo	isempty
appInfo	Checks if a variable is empty
appInfo	true
appInfo	Variables

element Items

diagram
children	Item

element Items/Item

diagram
children	Label Postback Items Session Popup

element Items/Item/Label

diagram

children

element Items/Item/Postback

diagram

children

element Items/Item/Session

diagram

children

element Items/Item/Popup

ListOptions Source KeyColumn ValueColumn WeightColumn Column

documentation	Used to hold the path of the clause in the compiler
appInfo	true

Name

xs:string

documentation	The name of the list, to be referenced by the other patterns
appInfo	name
appInfo	The name of the list, to be referenced by the other patterns
appInfo	true

documentation	Defines if the clause will be compiled
appInfo	true
appInfo	disabled
appInfo	Prevents the item to be compiled

documentation	Specifies if the item is private, that is, only clauses from the same file may reference it.
appInfo	true
appInfo	private
appInfo	Specifies if the item is private, that is, only clauses from the same file may reference it.

Instruct the compiler how to handle unreferenced item (e.g. data base connection) 'always' will keep the clause even if it is not referenced anywhere else. Use this when you reference clause by name like accessing connection by name.

annotation

documentation	LIST defines a key value table, List can be made from a database index or from an explicit values list. Later the list can be referenced to check if a value exists in the keys and to get the correlating value for the specified key
appInfo	Insert a clause of type list
appInfo	list
appInfo	true

element List/ListOptions

diagram

children

Use Metaphonetic Basic Snapshot FlexList BKTree TextSearch MLClassify ReversedSearch

annotation

documentation	Setup options, use this to select what type of list to use and configure the matching algorithems.
appInfo	Insert an explicit value list
appInfo	vlist
appInfo	true

element List/ListOptions/Use

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	xs:QName	required

annotation

documentation	not implemented yet
appInfo	1

element List/ListOptions/Metaphonetic

documentation	Specifies a matching algorithem, ranging from Fixed character to character exact match to Metaphonetic limited by the total number of character mismached
appInfo	like
appInfo	true
appInfo	Specifes matching algorithem.

Tolerance

optional

documentation	Specifies the number of changes between two tokens. A change is a replacement deletion or insert of a single character.
appInfo	tolerance

tolerancemethod

MaxTolerance

optional

documentation

Specify maximum tolerance in case of variable tolerance method (e.g Linear)

element List/ListOptions/Basic

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
AllowDuplicateKeys	xs:boolean	optional	true

annotation

documentation

Simple list without manipulation, can return shorterqlonger que to the engine

element List/ListOptions/Snapshot

diagram

annotation

documentation

Fast list (based on hash table) bu without the ability to return shorter/longer que. used as support for Flexlist. don't use in parsing

element List/ListOptions/FlexList

diagram

children

LoadTextProcessor SearchTextProcessor DropTokens TokensProperties UnrecognizedTokens

Weight of each Optional token from the data (not the search string!!)

documentation	Specify a maximum metaphonetic tolerance on any token
appInfo	tolerance

Tolerance calculation method for any specific token works with TokenTolerance

MatchType

documentation	Specifies a matching algorithem, ranging from Fixed character to character exact match to Metaphonetic limited by the total number of character mismached
appInfo	like
appInfo	true
appInfo	Specifes matching algorithem.

MaxWeight

xs:double

required

documentation	The maximum weight allowed for each match in the list, this is the internal weigh (meaning without extra calculations made by the processor).
appInfo	weight
appInfo	Max internal weight

RemoveDuplicateValues

xs:boolean

optional

documentation

remove duplicate results based on comparing the values, keeping the ones with the better weight.
The compare is string case insensitive.

Timeout for the search in mSec,

element List/ListOptions/FlexList/LoadTextProcessor

Configure the Text processor, no setting Filters or Tokenizers will revert to the defaults, standard tokenizer and no filters

element List/ListOptions/FlexList/SearchTextProcessor

Configure the Text processor, no setting Filters or Tokenizers will revert to the defaults, standard tokenizer and no filters

element List/ListOptions/FlexList/DropTokens

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
TokensDrop	FlexListSearchDropToken	optional
TokenWeight	xs:float	optional
OptionalTokensDrop	FlexListSearchDropToken	optional
OptionalTokenWeight	xs:float	optional

element List/ListOptions/FlexList/TokensProperties

diagram

children

List PropertiesByFilter

documentation	If true, duplicate word properties are overwritten by the last value
documentation	If true, duplicate word properties are overwritten by the last value
appInfo	allowduplicatekeys

element List/ListOptions/FlexList/TokensProperties/List

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	list_name	required

element List/ListOptions/FlexList/TokensProperties/PropertiesByFilter

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Optional	xs:boolean
ProhibitLastWord	xs:boolean
ProhibitFirstWord	xs:boolean
IsSupporting	xs:boolean
RegExFilter	xs:string	required

element List/ListOptions/FlexList/UnrecognizedTokens

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Ignore	xs:boolean	optional	true
Weight	xs:float	optional

element List/ListOptions/BKTree

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Top	xs:positiveInteger	optional	1
MaxWeight	xs:double	required

annotation

documentation

Use BKtree to quickly find the string with minimum edits (symetric Add  Remove). This is much faster then metaphonetic Free, but Add and Delete have the same cost

element List/ListOptions/TextSearch

diagram

children

SearchTextProcessor LoadTextProcessor UnrecognizedTokens

documentation	Specify a maximum metaphonetic tolerance on any token
appInfo	tolerance

Tolerance calculation method for any specific token works with TokenTolerance

MatchType

documentation	Specifies a matching algorithem, ranging from Fixed character to character exact match to Metaphonetic limited by the total number of character mismached
appInfo	like
appInfo	true
appInfo	Specifes matching algorithem.

MaxWeight

xs:double

required

documentation	The maximum weight allowed for each match in the list, this is the internal weigh (meaning without extra calculations made by the processor).
appInfo	weight
appInfo	Max internal weight

element List/ListOptions/TextSearch/SearchTextProcessor

Configure the Text processor, no setting Filters or Tokenizers will revert to the defaults, standard tokenizer and no filters

element List/ListOptions/TextSearch/LoadTextProcessor

Configure the Text processor, no setting Filters or Tokenizers will revert to the defaults, standard tokenizer and no filters

element List/ListOptions/TextSearch/UnrecognizedTokens

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Ignore	xs:boolean	optional	true
Weight	xs:float	optional

element List/ListOptions/MLClassify

diagram

children

SearchTextProcessor LoadTextProcessor

Upper limit on combined weight

factor on the Classify weight. 
Classify weight is a number between 0 to 1, percent of error. 
Usually we want less then 50% adn when combined with other apps less then 10%

Cache

xs:string

optional

element List/ListOptions/MLClassify/SearchTextProcessor

Configure the Text processor, no setting Filters or Tokenizers will revert to the defaults, standard tokenizer and no filters

element List/ListOptions/MLClassify/LoadTextProcessor

Configure the Text processor, no setting Filters or Tokenizers will revert to the defaults, standard tokenizer and no filters

element List/ListOptions/ReversedSearch

diagram

children

SearchTextProcessor LoadTextProcessor

attributes

Name	Type	Use	Default	Fixed	Annotation
ReorderCost	xs:double	required
ScatterCost	xs:double	required
TokenLocationCost	xs:double	required
TokenCountCost	xs:double	required
Top	xs:positiveInteger	optional	1

element List/ListOptions/ReversedSearch/SearchTextProcessor

Configure the Text processor, no setting Filters or Tokenizers will revert to the defaults, standard tokenizer and no filters

element List/ListOptions/ReversedSearch/LoadTextProcessor

Configure the Text processor, no setting Filters or Tokenizers will revert to the defaults, standard tokenizer and no filters

element List/Source

diagram

children

Use DatabaseTable DatabaseSQL VList CSV VBNetList ElasticKeyValue Json DataSource Binary

annotation

documentation	Defines the source of the data for key value map list. it is prefered to use DataSource other options will soon be deprecated
appInfo	Insert a list based on database table or query
appInfo	database_table
appInfo	true

element List/Source/Use

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	xs:QName	required

annotation

documentation	not implemented, will allow to reference another list as source
appInfo	1

element List/Source/DatabaseTable

documentation	Name of the connection to use in this database index list
appInfo	database_index
appInfo	true
appInfo	Name of the connection to use in this database index list

Table

xs:string

required

documentation	Name of the table to use
appInfo	table
appInfo	true
appInfo	Name of the table to use

annotation

documentation

The source is a database table, this will read the table directly by executing select * from table name. Use this only for tables with few fields.

element List/Source/DatabaseSQL

documentation	Name of the connection to use in this database index list
appInfo	database_index
appInfo	true
appInfo	Name of the connection to use in this database index list

annotation

documentation

Executes  the provided SQL and uses the returned recordset, you will need to sepecify the key and value columns (names of fields in the returned recordset)

element List/Source/DatabaseSQL/SQL

documentation	SQL to use, must be a select SQL
appInfo	sql
appInfo	true
appInfo	SQL

element List/Source/VList

VLIST is a definition of a dictionary made from keys and values where one value may have several keys.The VLIST enables defining each value and key by using the DO elements.VLIST enables caching the values and keys for increased performance or to dynamically generate the values and keys as needed caching is set using the CACHE child element.

element List/Source/VList/Entry

documentation	A single entry in a list, made from a set of one or more keys and a value. An entry has one value but may have more then one key. The keys has to be unique in the list.
appInfo	entry
appInfo	A single entry in a list, made from a set of one or more keys and a value
appInfo	true

element List/Source/VList/Entry/Key

diagram

children

annotation

documentation	Key is a string value that identifies the entry it is generated by inheriting DO child commands.The key has to be unique in the list and duplicate keys will result in unexpected behavior.
appInfo	key
appInfo	String value that identifies the entry
appInfo	true

element List/Source/VList/Entry/Value

diagram

children

annotation

documentation	The value of the entry in a form of string. Inherited DO child commands generate the value.
appInfo	value
appInfo	true
appInfo	The value of the entry in a form of string.

element List/Source/CSV

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
FileName	xs:string	required

annotation

documentation

Read a csv file, assuming the first line is a header that contans the fileds names.

element List/Source/VBNetList

element List/Source/ElasticKeyValue

diagram

children

Index Type KeyColumn ValueColumn ElasticJsonQuery

attributes

Name	Type	Use	Default	Fixed	Annotation
Connection	connection_name	required
Index

annotation

documentation	Loads a key value set from Elastic Search Index (can use filters)
appInfo	1

element List/Source/ElasticKeyValue/Index

diagram
type	xs:string

element List/Source/ElasticKeyValue/Type

diagram
type	xs:string

element List/Source/ElasticKeyValue/KeyColumn

diagram
type	xs:string

element List/Source/ElasticKeyValue/ValueColumn

diagram
type	xs:string

element List/Source/ElasticKeyValue/ElasticJsonQuery

diagram
type	xs:string

element List/Source/Json

diagram

children

JsonPath Key Value Source

attributes

Name	Type	Use	Default	Fixed	Annotation
ParseAs	xs:string	optional

annotation

documentation

Read the data from a JSON file, we assume that the json root contains an array  or a list of items, each item represent a single record, names are selected through the key ans value columns

element List/Source/Json/JsonPath

a JsonPath for a set of objects
http://goessner.net/articles/JsonPath/
https://support.smartbear.com/alertsite/docs/monitors/api/endpoint/jsonpath.html. For example $.channel.item[*] all the objects in item array

element List/Source/Json/Key

diagram

children

element List/Source/Json/Value

diagram

children

element List/Source/Json/Source

diagram
children	FileName Url

element List/Source/Json/Source/FileName

diagram

children

element List/Source/Json/Source/Url

diagram

children

element List/Source/DataSource

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	xs:Name	required

annotation

documentation

Specifies a name of a datasource

element List/Source/Binary

element List/Source/Binary/File

diagram

children

annotation

documentation	A binary file (format according to the list type) path relative to the project bin folder
appInfo	key
appInfo	String value that identifies the entry
appInfo	true

element List/KeyColumn

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Field	xs:QName	required

element List/ValueColumn

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Field	xs:QName	required

element List/WeightColumn

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Field	xs:QName	required

annotation

appInfo

true

element List/Column

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	xs:QName	required
Field	xs:QName	required

Value TrimBegin TrimEnd

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	Match a complex pattern, the value, allows a primitive Parse element in a single text line
appInfo	match complex pattern

appInfo	value
appInfo	true
documentation	Build a complex match pattern. where '{' '}' opens and closes a group, use '\|' to specify OR operation % for wildchar and [...] to call a rule

Name	Type	Use	Default	Fixed	Annotation
Operator	xs:string	required

annotation

documentation	Performs a mathematical calculation as defined in the input operation parameter: Add: adding one value to another. Substruct: subtracting a value from another value. Multiply: multiply a value with another one. Divide: divide a value with another one. Rand: provide a random number between the range of zero to the given number. PlusPlus: Adds one to the given number. MinusMinus: substracts one from the given number. Return value: The result of the calculation.
appInfo	math
appInfo	Performs a mathematical calculation
appInfo	true
appInfo	Math
appInfo	true

element NBSpace

diagram

type

restriction of xs:string

annotation

documentation	Enters a non-breaking space into the buffer.
appInfo	nbsp
appInfo	Enters a non-breaking space into the buffer.
appInfo	true
appInfo	Format

element Output

diagram

children

Button Clear CrLf Custom Dialer Form FormPostback Group BarcodeScanButton Header Html Image ImageList Link Markdown Media MediaButton MultiButton MultiSelect Mute New Navigate PathSelect PersistentMenu Planimetry Rating RatingMatrix Raw ReOrder RequestFile RequestLink RequestLocation RequestSignature SectionBreak Select Separator SetIntent SetSubject SetSummary SetResult Text RequestPicture Video VList VegaLite InternalUse

element Parse_Child_Hide

diagram

annotation

documentation

!! hidden element !!!!!!!!!!!!!!!!
Replace the compiler in case of Paser under Paser

element Parse_Inline_Hide

diagram

annotation

documentation	!!!!!! hidden element !!!!!!!!!!!!!!!! Replace the compiler in case of Paser under Inline
appInfo	false

element Parse_Pattern_Hide

diagram

annotation

documentation	!!!!!! hidden element !!!!!!!!!!!!!!!! Replace the compiler in case of Paser under Pattern
appInfo	false

element Parse_Trim_Hide

diagram

annotation

documentation	!!!!!! hidden element !!!!!!!!!!!!!!!! Replace the compiler in case of Trim
appInfo	false

element ParseALL_Child2_Hide

diagram

annotation

documentation


        !!!!! hidden element !!!!!!!!!!!!!!!!
        Replace by the compiler

element ParseALL_Terminator_Child2_Hide

diagram

annotation

documentation


        !!!!! hidden element !!!!!!!!!!!!!!!!
        Replace by the compiler

element ParseBest

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

annotation

documentation	selects the best way to split the token among the children, best way that will result in maximum weight.
appInfo	parsebest

element ParseBest_Terminator_Hide

diagram

annotation

documentation

!!!!! hidden element !!!!!!!!!!!!!!!!
Replace by the compiler

element ParsePermutations

diagram

children

Settings Item Spacer Rules

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

element ParsePermutations/Settings

Maximum number of items in a set, including spacers (if specified)

MinLength

xs:integer

required

documentation	Minimum number of items in a set including spacers (if specified)
appInfo	Minimum number of items in a set including spacers (if specified)

Mode

xs:string

required

documentation	Select which type of parse algorithem to use.
appInfo	Select which type of parse algorithem to use.

Select whether to embed as much as possible (at least the 1'st level) from the compiled permutation into the owner clause or place it a a separate rule.

appInfo

Embed parts of the compiled permutation into the owner clause

When true, the processor will first test the entire string to see if all the mandatory items exists before executing the diferent possible permutations. This is used to increase performancein cases where there are few mandatory items and the permutations number is very big

appInfo

When true, the processor will first test the entire string to see if all the mandatory items exists before executing the diferent possible permutations.

element ParsePermutations/Item

documentation	The minimum of times this item must apear in the permutation
appInfo	The minimum of times this item must apear in the permutation
appInfo	min_occurrences

MaxOccurrences

xs:integer

documentation	The maximum of times this item must apear in the permutation
appInfo	The maximum of times this item must apear in the permutation
appInfo	max_occurrences

You can set apecific positions for the item, allowed values are numbers from 0 to 9 specifying first place to 10th place or L0 to L9 specifying last position to 10th position from the end. multiple values can apear with space or comma as seperators. Also writing "All" will allow all positions (default).
Adding # means that after it the rest of the text is a comment

annotation

documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true

element ParsePermutations/Item/Call

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

Name

parse_name

required

appInfo	name
appInfo	RULENODE

annotation

documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true

element ParsePermutations/Item/Relations

documentation	Specifies a set of relations between the owner item to another items
appInfo	relation
appInfo	Specifies a set of relations between the owner item to another items

element ParsePermutations/Item/Relations/Relation

Name	Type	Use	Default	Fixed	Annotation
Type	PermutationRelations	required

annotation

documentation	Specifies a relation between the owner item to another item
appInfo	relation
appInfo	Specifies a relation between the owner item to another item

element ParsePermutations/Item/Relations/Relation/Item

diagram
type	xs:Name

element ParsePermutations/Spacer

Can the spacer contain text that can match one of the items in the permutation

MaxOccurrences

xs:integer

optional

documentation	The maximum of times this item must apear in the permutation
appInfo	The maximum of times this item must apear in the permutation
appInfo	max_occurrences

You can set apecific positions for the item, allowed values are numbers from 0 to 9 specifying first place to 10th place or L0 to L9 specifying last position to 10th position from the end. multiple values can apear with space or comma as seperators. Also writing "All" will allow all positions (default).
Adding # means that after it the rest of the text is a comment

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

element ParsePermutations/Spacer/ForbiddenContent

diagram
children	Call

element ParsePermutations/Spacer/ForbiddenContent/Call

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

Name

parse_name

required

appInfo	name
appInfo	RULENODE

annotation

documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true

element ParsePermutations/Rules

diagram
children	Switch Or

element ParsePermutations/Rules/Switch

documentation	The minimum of times this item must apear in the permutation
appInfo	The minimum of times this item must apear in the permutation
appInfo	required

annotation

documentation

Rule that specifies that only one of a set of permutation items may apear once in a solution. The rule itself has a Optional option to force one item from the set

element ParsePermutations/Rules/Switch/Item

diagram
type	xs:Name

element ParsePermutations/Rules/Or

diagram
children	Item

element ParsePermutations/Rules/Or/Item

diagram
type	xs:Name

documentation	Used to hold the path of the clause in the compiler
appInfo	true

Name

xs:Name

required

documentation	Use the name attribute to set explicitly a runtime ID for the pattern
appInfo	name
appInfo	true
appInfo	Sets the name of the element

Rank

optional

documentation

The Rank is a number between 1 and 100 which indicates the emphasis to be placed on this pattern as a potential match for the input.  A Rank of 100 represents a perfect match which should overide other potential matches. You can also use rank names e.g. Normal, low, high ...

appInfo

rank

appInfo

true

Divs

optional

documentation

 Links the patterns to a multiple devisions

documentation	Defines if the clause will be compiled
appInfo	true
appInfo	disabled
appInfo	Prevents the item to be compiled

Run

xs:string

optional

documentation	Defines a method for running the pattern: Normal RunOnce - the patterns is executed only once per interaction
appInfo	run

true

Cache

xs:string

optional

documentation	todo doc
appInfo	cache

CacheLifespan

amlduration

optional

documentation	todo doc
appInfo	CacheLifespan

tokens will enter the "unknown words" lists

Empty - Enter any subject with weight panelty.
'*' - Enter any subject with weight panelty including locked
'%' - Enter any subject without weight panelty (excluding locked)

appInfo

Empty - Enter any subject with weight panelty.
'*' - Enter any subject with weight panelty including locked
'%' - Enter any subject without weight panelty (excluding locked)

Keys

optional

documentation	Keys for chaning, key id used to concedure only part of the patterns.
appInfo	key

documentation	Use to override an existing pattern, this will simply remove the first pattern it finds with the specified name. It is intended to allow change in a shared file.
appInfo	Use to override an existing pattern

BaseForm

xs:boolean

optional

documentation	For internal use, Use this if a specific patter should handle baseforms even if it does not have keys (fit with "_")
appInfo	true

If true, the key of the pattern (if has key) is logged to the report database.
later the data collected can be used to create usage graphs

Instruct the compiler link to ensure that the keys for this pattern are unique in the entire project

annotation

documentation	Pattern element is the basic processing rule. It is comprised of two parts: The "IF" and the "THEN" that corespond to LHS-Left Hand Side and RHS-Right Hand Side. The LHS is made of several attributes and elements that combine to specify whether the rule will be activated for a specific input. The RHS is made of a single element 'do' that specifes a list of actions to be performed.
appInfo	Insert a clause of type pattern
appInfo	pattern
appInfo	true

element Pattern/Parse

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language Do

attributes

Name	Type	Use	Default	Fixed	Annotation
Optional	xs:boolean	optional	false

annotation

documentation	Parse element compares the input text to a complex template, that if is matched the pattern processing will continue.The Parse template is made from a collection of simple filters and logic operations.
appInfo	parse
appInfo	true
appInfo	Defines a specific parse pattern for testing inout text.

element Prompt

diagram

children

Type Wizard RegExPattern Mask Max Min Watermark InternalUse AutoCompleteClue AutoCompleteButtons ClearMenu Menu MenuAdd Progress ProgressStep InputKey ProgressClear Default

annotation

documentation

Force the user to a mask on input for text (where the channel supports, e.g. web) and force the user to use the buttons in the menu

Mask for the input "locked","text","number","date","datetime"...   empty means everything is allowed

element Prompt/Wizard

Instruct the UI about the wizard, when supported (e.g. "hide" )

element Prompt/RegExPattern

Mask specifies the input structure, e.g.  "__.__"

Maximum (inclusive)  for the input field, used only with Type

Minimum (inclusive)  for the input field, used only with Type

element Prompt/Watermark

Water mark to display in the input field

element Prompt/InternalUse

diagram

children

Prompt_Type Prompt_Mask Prompt_Watermark Prompt_AutoCompleteClue Prompt_AutoCompleteButtons Prompt_Min Prompt_Max Prompt_RegExPattern Prompt_ClearMenu Prompt_Menu Prompt_MenuAdd Prompt_Progress Prompt_ProgressStep Prompt_InputKey Prompt_ProgressClear Prompt_Default Prompt_Wizard

annotation

appInfo

true

element Prompt/InternalUse/Prompt_Type

diagram

element Prompt/InternalUse/Prompt_Mask

diagram

element Prompt/InternalUse/Prompt_Watermark

diagram

element Prompt/InternalUse/Prompt_AutoCompleteClue

diagram

element Prompt/InternalUse/Prompt_AutoCompleteButtons

diagram

element Prompt/InternalUse/Prompt_Min

diagram

element Prompt/InternalUse/Prompt_Max

diagram

element Prompt/InternalUse/Prompt_RegExPattern

diagram

element Prompt/InternalUse/Prompt_ClearMenu

diagram

element Prompt/InternalUse/Prompt_Menu

diagram

element Prompt/InternalUse/Prompt_MenuAdd

diagram

element Prompt/InternalUse/Prompt_Progress

diagram

element Prompt/InternalUse/Prompt_ProgressStep

diagram

element Prompt/InternalUse/Prompt_InputKey

diagram

element Prompt/InternalUse/Prompt_ProgressClear

diagram

element Prompt/InternalUse/Prompt_Default

diagram

element Prompt/InternalUse/Prompt_Wizard

diagram

element Prompt/AutoCompleteClue

diagram

children

attributes

Name	Type	Use	Default	Fixed	Annotation
Permanent	xs:boolean	optional	false

annotation

documentation

Provide a name of a set to the auto complete, so it will display correct values

element Prompt/AutoCompleteButtons

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Permanent	xs:boolean	optional	false
Enabled	xs:boolean	required

element Prompt/ClearMenu

diagram

element Prompt/Menu

diagram
children	Items

element Prompt/MenuAdd

diagram
children	Items

element Prompt/Progress

diagram
children	Min Max Value Units Header

element Prompt/Progress/Min

diagram

children

element Prompt/Progress/Max

diagram

children

element Prompt/Progress/Value

diagram

children

element Prompt/Progress/Units

diagram

children

element Prompt/Progress/Header

diagram

children

element Prompt/ProgressStep

Step the progress value bar with the provided expression

element Prompt/InputKey

A key that some channels can insert before the input to help system get the context of the text, used in web (js)...

element Prompt/ProgressClear

diagram

element Prompt/Default

Sets a value (when supported) in the input on the user device

element Replace

diagram

children

Expression List Find ReplaceWith

attributes

Name	Type	Use	Default	Fixed	Annotation
Occurrences	xs:string	optional
Separator	SeparatorType	optional
SeparatorBegin	SeparatorType	optional
SeparatorEnd	SeparatorType	optional
FailOn	xs:string	optional
ReduceMultiSpace	xs:boolean	optional

annotation

documentation

Replaces tokens inside the string. The input is an expression to be replaced. The replacement can be defined in three ways:
1. by find and replace the expression with a new string.
2. by find and replace the expression in a list, in a way that the matched keys in the list are the ones to be matched and replaced.
3. by find and replace the expression in a list, in a way that after matching the keys in the list. the values of the matched keys are the ones to be replaced in the list.

appInfo

replace

appInfo

Finds and Replaces a matching string in an expression.

element Replace/Expression

diagram

children

annotation

documentation	Expression doc
appInfo	value
appInfo	false
appInfo	Expression doc

element Replace/List

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	list_name	required

annotation

documentation	List used for replacing, the list properties such as MatchType will apply
appInfo	List used for Replace
appInfo	list
appInfo	true

documentation	The value to replace wih
appInfo	The value to replace wih
appInfo	value
appInfo	true

element Replace/ReplaceWith

diagram

children

annotation

documentation	Value to search for
appInfo	Value to search for
appInfo	key
appInfo	true

element Require

diagram

children

And Or Not VBNetRequire CsRequire Weight Exists IsEmpty Contains

annotation

documentation	The test section of the pattern is used to decide whether or not to continue processing the pattern. Test may check values from the profile, external inputs or time-date, thus allowing the pattern to behave differently at different times and for different users.
appInfo	true
appInfo	test
appInfo	Allow to test variables values or external inputs.

documentation	Used to hold the path of the clause in the compiler
appInfo	true

Hash

xs:string

optional

element Resource/Data

diagram
type	xs:string

element Root

diagram
children	Collection

element Rule

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language Do

documentation	Used to hold the path of the clause in the compiler
appInfo	true

Name

xs:string

documentation	The name of the parse, to be referenced by the other patterns
appInfo	name
appInfo	The name of the parse, to be referenced by the other patterns
appInfo	true

documentation	Specifies if the item is private, that is, only clauses from the same file may reference it.
appInfo	true
appInfo	private
appInfo	Specifies if the item is private, that is, only clauses from the same file may reference it.

documentation	Defines if the clause will be compiled
appInfo	true
appInfo	disabled
appInfo	Prevents the item to be compiled

Specifies a minimum weight for the Parse element to be concidured successful.
values are normanlized to scale of 0 to 1.

appInfo

Specifies a minimum weight for the Parse element to be concidured successful.
values are normanlized to scale of 0 to 1.

appInfo

weightmin

Determine handling the internal binds and what to pass to the caller. Private - all binds are private and the entire Rule returns a value generated in the Do part. Public - binds are accesible to the caller. Return - binds are private returns the first variable found that has the name 'return'

appInfo

binds

Used to disable the unknown words search for this rule. This is important in cases where the rule assumes that a nother rule ran before it (for example updating a global)

appInfo

Used to disable the unknown words search for this rule.

annotation

documentation	A 'parse' clause is a set of parsing elements that can be used in different patterns by referencing the 'parse' clause name using the 'inline' element.This is not a function call but the 'parse' clause is fully copied into the target element.'Parse’ clauses may be nested, that is they can reference themselves using the 'inline' element.
appInfo	parse
appInfo	true
appInfo	solo

Use to hide application secret, secrets can be placed here using the MakeSecret tool, only in runtime, the secret will be decoded in runtime. This element is used in connection passwords

documentation	Name of the variable to set
appInfo	set
appInfo	true
appInfo	Name of variable to set

annotation

documentation	Sets the value of a variable, the value to set is generated from executing the children of the element and combining the output buffers into a string.
appInfo	Set a value of a variable
appInfo	set
appInfo	true
appInfo	Variables

element Sp

diagram

type

restriction of xs:string

annotation

documentation	This is a simple replacement for writing a single whitespace in write. Write element with just a single space will collapse upon save thus the space will be lost.
appInfo	sp
appInfo	write single space

Name	Type	Use	Default	Fixed	Annotation
Operator	xs:string	optional

annotation

documentation	Compares two values as strings. If the strings are the same true is returned, if not false. This command does not write to the output buffer; it is not case sensitive.
appInfo	Compare two values as strings.
appInfo	true
appInfo	strcomp
appInfo	do/strcomp
appInfo	Variables

element Terminator_Hide

diagram

annotation

documentation


        !!!!! hidden element !!!!!!!!!!!!!!!!
        Replace by the compiler

element TerminatorChar_Hide

diagram

annotation

documentation


        !!!!! hidden element !!!!!!!!!!!!!!!!
        Replace by the compiler

Name	Type	Use	Default	Fixed	Annotation
Type	TraceType

annotation

documentation	Trace
appInfo	Trace to the output string
appInfo	trace

Name	Type	Use	Default	Fixed	Annotation
Operator	xs:string	optional
ReduceMultiSpace	xs:boolean	optional	true

annotation

documentation

Removes characters from either begining and/or end of the string.The input is an expression string to reduce from and a TrimWhat parameter which defines what character list to reduce from the input string.

For example:

 <Trim Operator="Last" ReduceMultiSpace="true">
	<Expression>
		<Get>/temp/t</Get>
	</Expression>
	<TrimWhat>?,$</TrimWhat>
</Trim>

appInfo

trim

appInfo

Removes characters list from the begining and/or end an input string.

element Trim/Expression

diagram

children

element Trim/TrimWhat

(\[Any\])|((\[(Hebrew|English|Number)\]|\[\w-\w\]|\w|\\\\|\\\[|\\\]|[_'`^\w -A{-¾])*)

documentation	Places a predefined item
appInfo	Places a predefined item
appInfo	place
appInfo	true

Name	Type	Use	Default	Fixed	Annotation
FunctionName	xs:string	optional

annotation

appInfo

vbnet

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

annotation

appInfo

vbnet

Name	Type	Use	Default	Fixed	Annotation
FunctionName	xs:string	optional

annotation

appInfo

vbnet

element View

diagram

children

InternalUse Interface LockDialog PinnedMessageClear PinnedMessage SpinnerClear Spinner MetronomeStop Metronome

annotation

documentation

Force the user to a mask on input for text (where the channel supports, e.g. web) and force the user to use the buttons in the menu

element View/InternalUse

diagram

children

View_PinnedMessageClear View_PinnedMessage View_Interface View_LockDialog View_MetronomeStop View_Metronome View_SpinnerClear View_Spinner

annotation

appInfo

true

element View/InternalUse/View_PinnedMessageClear

diagram

element View/InternalUse/View_PinnedMessage

diagram

element View/InternalUse/View_Interface

diagram

element View/InternalUse/View_LockDialog

diagram

element View/InternalUse/View_MetronomeStop

diagram

element View/InternalUse/View_Metronome

diagram

element View/InternalUse/View_SpinnerClear

diagram

element View/InternalUse/View_Spinner

diagram

element View/Interface

diagram
children	InteractionMode

element View/Interface/InteractionMode

diagram

children

element View/LockDialog

diagram
children	Mode

element View/LockDialog/Mode

diagram

children

element View/PinnedMessageClear

diagram

element View/PinnedMessage

diagram

children

element View/SpinnerClear

diagram

element View/Spinner

diagram
children	Label

element View/Spinner/Label

diagram

children

element View/MetronomeStop

diagram

element View/Metronome

diagram
children	Interval

element View/Metronome/Interval

Sets a value (when supported) in the input on the user device

element Weight

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

annotation

documentation	Provides a number between 0-1 to reduce the weight of the input string.
appInfo	weight

element Write

diagram

type

extension of xs:string

attributes

Name	Type	Use	Default	Fixed	Annotation
Language	Language	optional

annotation

documentation	Writes element text to selected output. Text can include white spaces; XML rules apply to the text. It is best not to include CR, LF or other formating within write; instead, use the appropriate elements. Note: Write must include more characters than spaces only, or the editor and compiler will collapse the space!
appInfo	Specify a text to be appended to buffer
appInfo	write
appInfo	true

group ContentElements

diagram

group DoAuthCommands

diagram
children	Logout Login CreateOtpQrCode AddUser

element DoAuthCommands/Logout

diagram

element DoAuthCommands/Login

diagram
children	AuthType UserName Password PasswordHash Context Key OtpPassword BindResult

element DoAuthCommands/Login/AuthType

empty for User Name password, or the Key type from EndUserKeys

element DoAuthCommands/Login/UserName

diagram

children

element DoAuthCommands/Login/Password

diagram

children

element DoAuthCommands/Login/PasswordHash

A password hash

element DoAuthCommands/Login/Context

What is the context of the login, session, device

element DoAuthCommands/Login/Key

diagram

children

element DoAuthCommands/Login/OtpPassword

Optional, the OTP entered by the user, if the user is set to 2FA, and OTP is not provided, missing OTP is returned in result

element DoAuthCommands/Login/BindResult

diagram

children

element DoAuthCommands/CreateOtpQrCode

diagram
children	UserName BindKey BindRecovery BindImage

element DoAuthCommands/CreateOtpQrCode/UserName

diagram

children

element DoAuthCommands/CreateOtpQrCode/BindKey

diagram

children

element DoAuthCommands/CreateOtpQrCode/BindRecovery

diagram

children

element DoAuthCommands/CreateOtpQrCode/BindImage

diagram

children

element DoAuthCommands/AddUser

diagram
children	UserName Password Email BindResult

element DoAuthCommands/AddUser/UserName

diagram

children

element DoAuthCommands/AddUser/Password

diagram

children

element DoAuthCommands/AddUser/Email

diagram

children

element DoAuthCommands/AddUser/BindResult

documentation	A group of possible actions in do (e.g., write, var_get...). This is stored as a group to allow access to the same actions through other action- grouping elements (Determ, Random...). The different child elements are organized as a list of selections.
appInfo	DoChildren
appInfo	DoChildren
appInfo	true

Name	Type	Use	Default	Fixed	Annotation
Key	Key	required

annotation

documentation	Creates a new engine and runs it using the Key and node children as input; it then appends the result to the buffer. Call is slower then Chain. For this reason if there is no need to combine results use Chain.
appInfo	Recursivly call another pattern by Key
appInfo	call
appInfo	true
appInfo	Flow

Execute the provided JavaScript code

documentation	'do' element has several meanings: 1) 'do' acts as the RHS part of patterns. It contains all the executable action to be taken by the pattern. 2) When used inside another 'do', it simply acts as a container for a set of elements. When called it will call all of it's child elements disregarding the return status of those elements. 3) When used inside 'parse', it must be the last element in the parse, 'do' can be used to make more tests over bounded variables. If any of it's child elements will fail, it will fail the 'parse' element itself. However it will allways execute all of it's child elements.
appInfo	Execute a list of actions.
appInfo	do
appInfo	true
appInfo	Flow
appInfo	do/do

element DoChild/Random

diagram

children

annotation

documentation	Random will try to execute its children randomly until one child returns a SUCCESSFUL status. If all child elements are marked FAIL them random will mark itself as FAIL.
appInfo	Random - Select random child to execute
appInfo	random
appInfo	true
appInfo	master
appInfo	Flow

documentation	Sets a redo flag for the pattern. This forces the complete output buffer to be resubmitted to the engine (i.e., recursive). The output resubmitted by Redo cannot be combined with regular output (write) -- for a combined output, use Recursive.
appInfo	Instruct the engine to send the complete generated output of the pattern back as a new input.
appInfo	true
appInfo	redo
appInfo	master
appInfo	Flow

element DoChild/Recursive

documentation	Creates a new engine and runs it using the node children as input; it then appends the result to the buffer. Recursive is slower then Redo. For this reason if there is no need to combine results use Redo.
appInfo	Recursivly generates a reply for the input and add it to the buffer.
appInfo	recursive
appInfo	true
appInfo	Flow

element DoChild/Visit

diagram

children

Key Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

documentation	Creates a new engine and runs it using the node children as input; it then appends the result to the buffer. Visit is slower then Chain.
appInfo	Visit a pattern generates a reply for the input and add it to the buffer.
appInfo	visit
appInfo	true
appInfo	Flow

element DoChild/Visit/Key

diagram

children

element DoChild/FailByBuffer

Run the children and if the buffer can be evaluated to false, fail

documentation	Inverts the status of the child nodes
appInfo	Invert the status of the child nodes
appInfo	true
appInfo	not
appInfo	master
appInfo	Logic
appInfo	do/not

element DoChild/DocxToPdf

diagram

children

StoreIn Template Audit Format

annotation

documentation	Inverts the status of the child nodes
appInfo	Invert the status of the child nodes
appInfo	true
appInfo	not
appInfo	master
appInfo	Logic
appInfo	do/not

element DoChild/DocxToPdf/StoreIn

diagram

children

element DoChild/DocxToPdf/Template

diagram

children

element DoChild/DocxToPdf/Audit

diagram

children

element DoChild/DocxToPdf/Format

diagram

children

element DoChild/DocxToDocx

diagram

children

StoreIn Template Audit Format

annotation

documentation	Inverts the status of the child nodes
appInfo	Invert the status of the child nodes
appInfo	true
appInfo	not
appInfo	master
appInfo	Logic
appInfo	do/not

element DoChild/DocxToDocx/StoreIn

diagram

children

element DoChild/DocxToDocx/Template

diagram

children

element DoChild/DocxToDocx/Audit

diagram

children

element DoChild/DocxToDocx/Format

diagram

children

element DoChild/XlsxToXlsx

documentation	Inverts the status of the child nodes
appInfo	Invert the status of the child nodes
appInfo	true
appInfo	not
appInfo	master
appInfo	Logic
appInfo	do/not

element DoChild/XlsxToXlsx/StoreIn

diagram

children

element DoChild/XlsxToXlsx/Template

appInfo	name
appInfo	listnode
appInfo	do/list/@name

Tolerance

optional

documentation	Specifies the number of changes between two tokens. A change is a replacement deletion or insert of a single character.
appInfo	tolerance

tolerancemethod

MaxTolerance

optional

documentation

Specify maximum tolerance in case of variable tolerance method (e.g Linear)

annotation

documentation	Searches a list for the specified key and returns the values ascosiated with that key. If the key can not be found an empty string is returned and the element's fail status is activated.
appInfo	list
appInfo	Returns the value ascocited with the specified key
appInfo	true
appInfo	do/list

element DoChild/AutoCorrect

documentation	Removes punctuation symbol at the end of the input (e.g. '?', '!', '.' ...)
appInfo	Removes end punctuation symbols.
appInfo	true
appInfo	removeendpunctuation

RemoveStartPunctuation

xs:boolean

optional

false

documentation	Removes punctuation symbol at the begining of the input (e.g. '?', '!', '.' ...).
appInfo	removestartpunctuation
appInfo	true
appInfo	Removes begining punctuation symbols.

HebrewFinalLetterFixup

xs:boolean

optional

false

documentation	1) Find all the places where final letters in hebrew are followed by a letter or digit for example "יוםשני". so the ם should be replaced with מ and a space, so the result should be "יומ שני" 2) Replace all the final letters to regular letters ץ ---> צ ף ----> פ ם ---> מ ך ----> כ
appInfo	element
appInfo	true
appInfo	Remove hebrew final letters

annotation

documentation	Performs autocorrect dictionary on the input
appInfo	Perform auto correct dictionary on the input
appInfo	autocorrect
appInfo	false
appInfo	do/autocorrect

Optionally specify the type of value from the evaluation, if not specified the processor will try to determine the type in runtime

annotation

documentation	Evaluate the text using VBScript engine
appInfo	Evaluate the text using VBScript engine
appInfo	element
appInfo	true
appInfo	Math
appInfo	true

element DoChild/Weight

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

annotation

appInfo

weight

element DoChild/LockCurrentSubject

diagram

annotation

appInfo	locksubject
documentation	prevent other patterns from changing the subject, the system will concedure only element in the current subject or *
appInfo	Locks the current subject, only allowed pattern will be concedured

element DoChild/UnlockCurrentSubject

diagram

element DoChild/SetSubject

diagram

children

element DoChild/ClearSubject

diagram

annotation

documentation

Clears the current subject, thus allowing all relevant patterns to be concedured

element DoChild/MetaData

documentation	The name of the metadata attribute apended to the XML output from the processor.
appInfo	name
appInfo	true
appInfo	solo
documentation	The name of the metadata attribute apended to the XML output from the processor.

annotation

documentation	Adds a new attribute to the metadata element in the XML output from the processor. Those attributes are not part of the answer to the user and can be used to send meta data to the interface module, both for formatting and for triggering business logic.
appInfo	metadata
appInfo	true
appInfo	Adds a new attribute into the metadata element in the XML outpu from the processor.
appInfo	do/MetaData

element DoChild/Chain

documentation	Set the key
appInfo	key

If specified, then later in another pattern when a call "End" will "chain" the specified name, this will for example allow to make a subroutine in a menu tree

Set to true if you don't want to clear the buffer before writing the content of the chain element (the default is false)

annotation

documentation	Chain this pattern output to another patter with matching key
appInfo	chain

element DoChild/TextProcessor

diagram
children	Input Tokenizer Filters

element DoChild/TextProcessor/Input

diagram

children

element DoChild/SendEmail

diagram

children

Sender From To Cc Bcc Subject Template Attachments

annotation

documentation

Sends an SMS to specified phone number

element DoChild/SendEmail/Sender

Instruct the display to use monospace font, useful for displaying text tables and lists

Phone number to send the SMS (full international number)

element DoChild/SendEmail/From

Instruct the display to use monospace font, useful for displaying text tables and lists

Optional name of provider to use

element DoChild/SendEmail/To

Instruct the display to use monospace font, useful for displaying text tables and lists

Phone number to send the SMS (full international number)

element DoChild/SendEmail/Cc

Instruct the display to use monospace font, useful for displaying text tables and lists

Phone number to send the SMS (full international number)

element DoChild/SendEmail/Bcc

Instruct the display to use monospace font, useful for displaying text tables and lists

Phone number to send the SMS (full international number)

element DoChild/SendEmail/Subject

Instruct the display to use monospace font, useful for displaying text tables and lists

Content of the SMS

element DoChild/SendEmail/Template

Instruct the display to use monospace font, useful for displaying text tables and lists

Content of the SMS

element DoChild/SendEmail/Attachments

diagram
children	Attachment

element DoChild/SendEmail/Attachments/Attachment

diagram
children	Key

element DoChild/SendEmail/Attachments/Attachment/Key

Instruct the display to use monospace font, useful for displaying text tables and lists

Phone number to send the SMS (full international number)

element DoChild/SmsSend

Sends an SMS to specified phone number

element DoChild/SmsSend/Content

Instruct the display to use monospace font, useful for displaying text tables and lists

Content of the SMS

element DoChild/SmsSend/Provider

Instruct the display to use monospace font, useful for displaying text tables and lists

Optional name of provider to use

element DoChild/SmsSend/To

Instruct the display to use monospace font, useful for displaying text tables and lists

Phone number to send the SMS (full international number)

element DoChild/End

diagram

type

restriction of xs:string

annotation

documentation

If a Chain with returnTo is active, chain to the returnTo else do nothing

element DoChild/VerifyAuthorized

diagram
children	OnNotAuthorizedChainTo

element DoChild/VerifyAuthorized/OnNotAuthorizedChainTo

diagram
children	Key

element DoChild/VerifyAuthorized/OnNotAuthorizedChainTo/Key

diagram

children

element DoChild/Language

diagram
children	Arabic Amharic Chinese_Simplified Chinese_Traditional English_US English_GB French German Hebrew Japanese Malay Neutral Russian Spanish

element DoChild/Language/Arabic

diagram

children

element DoChild/Language/Amharic

diagram

children

element DoChild/Language/Chinese_Simplified

diagram

children

element DoChild/Language/Chinese_Traditional

diagram

children

element DoChild/Language/English_US

diagram

children

element DoChild/Language/English_GB

diagram

children

element DoChild/Language/French

diagram

children

element DoChild/Language/German

diagram

children

element DoChild/Language/Hebrew

diagram

children

element DoChild/Language/Japanese

diagram

children

element DoChild/Language/Malay

diagram

children

element DoChild/Language/Neutral

diagram

children

element DoChild/Language/Russian

diagram

children

element DoChild/Language/Spanish

diagram

children

element DoChild/IsMatch

diagram

children

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	parse_name	required

annotation

documentation

Simple true false test of text against a specific rule, returns true if the rule is matched.

element DoChild/DofScript

Execute a DragOnFlow script

element DoChild/DofEvaluate

Evaluate DragOnFlow script expression and return the result

element DoChild/GetResourceKey

diagram
children	Resource RequestedType ResourceType Preprocess

element DoChild/GetResourceKey/Resource

diagram

children

element DoChild/GetResourceKey/RequestedType

diagram

children

element DoChild/GetResourceKey/ResourceType

diagram

children

element DoChild/GetResourceKey/Preprocess

diagram

children

element DoChild/MessagesReport

diagram
children	Title Language MaxMessages DescendingOrder Filters BindResult

element DoChild/MessagesReport/Title

diagram
type	MixedValue
children	Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

element DoChild/MessagesReport/Language

diagram
type	MixedValue
children	Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

element DoChild/MessagesReport/MaxMessages

diagram
type	MixedValue
children	Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

element DoChild/MessagesReport/DescendingOrder

diagram
type	MixedValue
children	Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

element DoChild/MessagesReport/Filters

diagram
children	Filter

element DoChild/MessagesReport/Filters/Filter

diagram
type	MixedValue
children	Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

element DoChild/MessagesReport/BindResult

diagram
type	MixedValue
children	Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

Group that allows endless numbers  of do_child group entries.

group DoParseChild

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

annotation

documentation	A collection of all posible commands under parse
appInfo	false

element DoParseChild/Do

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

annotation

documentation	'do' element has several meanings: 1) 'do' acts as the RHS part of patterns. It contains all the executable action to be taken by the pattern. 2) When used inside another 'do', it simply acts as a container for a set of elements. When called it will call all of it's child elements disregarding the return status of those elements. 3) When used inside 'parse', it must be the last element in the parse, 'do' can be used to make more tests over bounded variables. If any of it's child elements will fail, it will fail the 'parse' element itself. However it will allways execute all of it's child elements.
appInfo	Execute a list of actions.
appInfo	do
appInfo	true
appInfo	Flow
appInfo	do/do

element DoParseChild/Get

documentation	Gets the value of a variable. The Get keyword changes its function depending on its location in the clause: In Do the Get retrieves a variable value to the output sink (i.e. write). In Parse it is used to symbolically match a value to a variable.
appInfo	get
appInfo	Retrieves the value of a variable
appInfo	Variables
appInfo	do/get

element DoParseChild/Peek

diagram

type

TempVariablePathWithMember

facets

pattern

^([a-zA-Z][a-zA-Z0-9_:]*/)*[a-zA-Z][a-zA-Z0-9_:]*[.](text|value|weight|key)\z

annotation

documentation	Retrieves the current value of the variable that could be bounded to a parse element. The value retrieved is the current value of the variable when accessed; this is not neccesarily the value of the variable when the parse is completed.
appInfo	Peeks the current value of a temporary bounded variable.
appInfo	true
appInfo	peek
appInfo	Variables

element DoParseChild/Bind

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

TempVariablePathWithMember

required

documentation	Name of a variable
appInfo	Name of the variable to use
appInfo	name
appInfo	true

annotation

appInfo	bind
appInfo	Binds the value of the token into the temporary variable name
appInfo	true
appInfo	parse/do/bind
appInfo	Variables

element DoParseChild/List

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

appInfo	name
appInfo	listnode
appInfo	do/list/@name

annotation

documentation	Searches a list for the specified key and returns the values ascosiated with that key. If the key can not be found an empty string is returned and the element's fail status is activated.
appInfo	list
appInfo	Returns the value ascocited with the specified key
appInfo	true
appInfo	do/list

element DoParseChild/Field

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	xs:string	required

annotation

documentation	Gets a value from the database into a variable
appInfo	Gets a value from the database into a variable
appInfo	field
appInfo	true
appInfo	do/field

element DoParseChild/Not

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

annotation

documentation	Inverts the status of the child nodes
appInfo	Invert the status of the child nodes
appInfo	true
appInfo	not
appInfo	master
appInfo	Logic
appInfo	do/not

element DoParseChild/Weight

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

annotation

appInfo

weight

element DoParseChild/ShortcutsApply

documentation	Defines the type of search to use when replacing shortcuts. Option are to replace any part of string, the beginning of the string or the entire string
appInfo	type
appInfo	true
appInfo	Type of search to use

annotation

documentation	Shortcut element allows setting, retrieving and clearing shortcuts
appInfo	Specify an action in the shortcuts collection
appInfo	shortcut_apply
appInfo	false
appInfo	Shortcuts

group DoParseChildren

diagram
children	Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

group DoStackCommands

diagram
children	StackPush Checkpoint StackPop

element DoStackCommands/StackPush

diagram

children

Name Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

annotation

documentation

A simple stack (LIFO) where you can push an pop values, the stack is stored in location specified by name. To use simply call StackPush with the storage location and write to the buffer, the buffer will be stored in the stack for later use.

element DoStackCommands/StackPush/Name

diagram

children

element DoStackCommands/Checkpoint

Logs the value in checkpoint to the database for later analysis report (e.g. know how many users passed through a specific point)

element DoStackCommands/StackPop

Try to pop a single value from the stack and writes it to the buffer

group DoUnusedCommands

diagram
children	Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution

element DoUnusedCommands/Or

diagram

children

annotation

documentation	Performs logical Or on the results from it's children
appInfo	Performs logical OR on the results from it's children
appInfo	or
appInfo	true
appInfo	Logic
appInfo	true

element DoUnusedCommands/And

diagram

children

annotation

documentation	Performs logical AND on the results from it's children
appInfo	Performs logical AND on the results from it's children
appInfo	and
appInfo	true
appInfo	Logic
appInfo	true

element DoUnusedCommands/Parameter

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	xs:string	required

annotation

documentation	Gets a value from the database into a variable
appInfo	Gets a value from the database into a variable
appInfo	parameter
appInfo	true
appInfo	master
appInfo	Database
appInfo	true

element DoUnusedCommands/Field

documentation	Name of the field
appInfo	name

annotation

documentation	Gets a value from the database into a variable
appInfo	Gets a value from the database into a variable
appInfo	field
appInfo	true
appInfo	master
appInfo	Database
appInfo	true

element DoUnusedCommands/ForEachSolution

diagram

children

annotation

documentation	Allows to run code for each possible solution, the binfs in this code will be deleted after leaving the command
appInfo	true

group DoVariablesCommands

diagram
children	Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear

element DoVariablesCommands/Get

diagram

children

annotation

documentation	Gets the value of a variable. The Get keyword changes its function depending on its location in the clause: In Do the Get retrieves a variable value to the output sink (i.e. write). In Parse it is used to symbolically match a value to a variable.
appInfo	get
appInfo	Retrieves the value of a variable
appInfo	Variables
appInfo	do/get

element DoVariablesCommands/Copy

diagram
children	From To

element DoVariablesCommands/Copy/From

diagram

children

annotation

documentation	Gets the value of a variable. The Get keyword changes its function depending on its location in the clause: In Do the Get retrieves a variable value to the output sink (i.e. write). In Parse it is used to symbolically match a value to a variable.
appInfo	get
appInfo	Retrieves the value of a variable
appInfo	Variables
appInfo	do/get

element DoVariablesCommands/Copy/To

diagram

children

annotation

documentation	Gets the value of a variable. The Get keyword changes its function depending on its location in the clause: In Do the Get retrieves a variable value to the output sink (i.e. write). In Parse it is used to symbolically match a value to a variable.
appInfo	get
appInfo	Retrieves the value of a variable
appInfo	Variables
appInfo	do/get

element DoVariablesCommands/Set

appInfo	name
appInfo	true

LifeSpan

xs:integer

optional

documentation	sets the life span of variables
appInfo	sets the life span of variables
appInfo	lifespan
appInfo	true

annotation

documentation	Sets the value of a variable. The value set is generated by executing the children of the element and combining the output buffers into a string.
appInfo	Set a value of a variable
appInfo	set
appInfo	true
appInfo	Variables
appInfo	do/set

element DoVariablesCommands/Bind

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

TempVariablePathWithMember

required

documentation	Name of a variable
appInfo	Name of the variable to use
appInfo	name
appInfo	true

annotation

appInfo	bind
appInfo	Binds the value of the token into the temporary variable name
appInfo	true
appInfo	parse/do/bind
appInfo	Variables

element DoVariablesCommands/Peek

diagram

type

TempVariablePathWithMember

facets

pattern

^([a-zA-Z][a-zA-Z0-9_:]*/)*[a-zA-Z][a-zA-Z0-9_:]*[.](text|value|weight|key)\z

annotation

documentation	Retrieves the current value of the variable that could be bounded to a parse element. The value retrieved is the current value of the variable when accessed; this is not neccesarily the value of the variable when the parse is completed.
appInfo	Peeks the current value of a temporary bounded variable.
appInfo	true
appInfo	peek
appInfo	Variables

element DoVariablesCommands/VListPrepend

Prepend the value into the list named Name

element DoVariablesCommands/VListPrepend/Name

diagram

children

element DoVariablesCommands/VListPrepend/Value

diagram

children

element DoVariablesCommands/VListAppend

A simple stack (LIFO) where you can push an pop values, the stack is stored in location specified by name. To use simply call StackPush with the storage location and write to the buffer, the buffer will be stored in the stack for later use.

element DoVariablesCommands/VListAppend/Name

diagram

children

element DoVariablesCommands/VListAppend/Value

diagram

children

element DoVariablesCommands/VListClear

A simple stack (LIFO) where you can push an pop values, the stack is stored in location specified by name. To use simply call StackPush with the storage location and write to the buffer, the buffer will be stored in the stack for later use.

group OutputChildren

diagram

children

element OutputChildren/Button

diagram

children

Text Style Completed Disabled

Size of the button
Auto - Size to the text

Use to display a button to the user that is not directing to another page or request. The button simply sends a Request to the VM but no direction is done.
Use it for example to display "Thumbs Up" to allow the user to tell the VM the reply is a good one

element OutputChildren/Button/Text

diagram

children

element OutputChildren/Button/Style

diagram

children

element OutputChildren/Button/Completed

diagram

children

element OutputChildren/Button/Disabled

diagram

children

element OutputChildren/Clear

diagram

annotation

documentation

Delete all the content on the output

element OutputChildren/Custom

Name of the connectors this command is intended for (comma separated)

element OutputChildren/Dialer

diagram

children

PhoneNumber Postback Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

element OutputChildren/Dialer/PhoneNumber

diagram

children

element OutputChildren/Dialer/Postback

When true, instructs the connector to hide the postback and it's reply from the user. Use it when you need to know that the user clicked the link button but without indication in the dialog. only some connectors support this (mainly web)

annotation

documentation

Used to inform the processor that the user clicked the dialer (where the channel supports, like in web bot), this is optional. The processor can reply normally

element OutputChildren/Form

diagram
children	Style Submit Skip Cancel Content ViewAs Header Mode Changed AuditFragment Path

element OutputChildren/Form/Style

diagram

children

element OutputChildren/Form/Submit

diagram
children	Label Postback

element OutputChildren/Form/Submit/Label

diagram

children

element OutputChildren/Form/Submit/Postback

diagram
children	Key

element OutputChildren/Form/Submit/Postback/Key

diagram

children

element OutputChildren/Form/Skip

diagram
children	Label Postback

element OutputChildren/Form/Skip/Label

diagram

children

element OutputChildren/Form/Skip/Postback

diagram
children	Key

element OutputChildren/Form/Skip/Postback/Key

diagram

children

element OutputChildren/Form/Cancel

diagram
children	Label

element OutputChildren/Form/Cancel/Label

diagram

children

element OutputChildren/Form/Content

diagram
children	Resource

element OutputChildren/Form/Content/Resource

diagram

children

element OutputChildren/Form/ViewAs

diagram
children	Button Inline

element OutputChildren/Form/ViewAs/Button

diagram
children	Label

element OutputChildren/Form/ViewAs/Button/Label

diagram

children

element OutputChildren/Form/ViewAs/Inline

diagram

element OutputChildren/Form/Header

Overrides the header from the form (resource...)

element OutputChildren/Form/Mode

If loading data then you must specify 'Path' as well

element OutputChildren/Form/Changed

diagram

children

element OutputChildren/Form/AuditFragment

diagram

children

element OutputChildren/Form/Path

diagram

children

element OutputChildren/FormPostback

diagram
children	Content ViewAs Header AuditFragment Mode Changed Path

element OutputChildren/FormPostback/Content

diagram
children	Resource

element OutputChildren/FormPostback/Content/Resource

diagram

children

element OutputChildren/FormPostback/ViewAs

diagram
children	Button Inline

element OutputChildren/FormPostback/ViewAs/Button

diagram
children	Label

element OutputChildren/FormPostback/ViewAs/Button/Label

diagram

children

element OutputChildren/FormPostback/ViewAs/Inline

diagram

element OutputChildren/FormPostback/Header

Overrides the header from the form (resource...)

element OutputChildren/FormPostback/AuditFragment

diagram

children

element OutputChildren/FormPostback/Mode

If loading data then you must specify 'Path' as well

element OutputChildren/FormPostback/Changed

diagram

children

element OutputChildren/FormPostback/Path

diagram

children

element OutputChildren/Group

diagram

children

Style Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

attributes

Name	Type	Use	Default	Fixed	Annotation
Flow	xs:string	optional

element OutputChildren/Group/Style

diagram

children

element OutputChildren/BarcodeScanButton

diagram
children	Label Completed Style Disabled Postback Title Filter

element OutputChildren/BarcodeScanButton/Label

diagram

children

element OutputChildren/BarcodeScanButton/Completed

diagram

children

element OutputChildren/BarcodeScanButton/Style

diagram

children

element OutputChildren/BarcodeScanButton/Disabled

diagram

children

element OutputChildren/BarcodeScanButton/Postback

diagram

children

element OutputChildren/BarcodeScanButton/Title

Image data e.g. like image stored in CSS or HTML: data:image/jpg,/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAA

element OutputChildren/BarcodeScanButton/Filter

Optional, if present indicate how the requested media format should be converted to, relevant when doing Preprocess and in Resource

element OutputChildren/Header

diagram

children

attributes

Name	Type	Use	Default	Fixed	Annotation
Level	xs:unsignedShort	required

annotation

appInfo

header

element OutputChildren/Html

diagram

type

extension of xs:string

attributes

Name	Type	Use	Default	Fixed	Annotation
HasFields	xs:boolean	optional	false

annotation

documentation

Output a HTML block as is, this is supported only on web, take care when using not to overwrite styles or exit the chat area. The html may contain variables fields in the {{name}} format setting 'HasFields' property will cause to replace the fields with values (where possible)

element OutputChildren/Image

diagram

children

Source Size AltText Title Label Postback Assign

attributes

Name	Type	Use	Default	Fixed	Annotation
ViewAs	xs:string

element OutputChildren/Image/Source

diagram
children	Url Data Key Resource

element OutputChildren/Image/Source/Url

diagram

children

element OutputChildren/Image/Source/Data

Image data e.g. like image stored in CSS or HTML: data:image/jpg,/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAA

element OutputChildren/Image/Source/Key

The key for the image as an expression (e.g. a variable name)

element OutputChildren/Image/Source/Resource

The resource name as an expression (e.g. a variable name)

element OutputChildren/Image/Size

diagram

children

annotation

documentation	Altername text, sets the alt text of the image (this is for accessability), if not specified and a title is available, the title is used
appInfo	Sets the Alt text of the image (for screen readers)

element OutputChildren/Image/AltText

diagram

children

annotation

documentation	Altername text, sets the alt text of the image (this is for accessability), if not specified and a title is available, the title is used
appInfo	Sets the Alt text of the image (for screen readers)

element OutputChildren/Image/Title

diagram

children

annotation

documentation	Title of the image, shown when the image is opened
appInfo	Title of the image, shown when the image isi opened

element OutputChildren/Image/Label

diagram

children

annotation

documentation	The label on the button (if in view as button mode)
appInfo	The label on the button (if in view as button mode)

element OutputChildren/Image/Postback

diagram

children

element OutputChildren/Image/Assign

If possible, stores the source of the image, take care in embedded images as this will store the entire image data

element OutputChildren/ImageList

Name	Type	Use	Default	Fixed	Annotation
ViewAs	xs:string

element OutputChildren/ImageList/Items

diagram
children	Image

element OutputChildren/ImageList/Items/Image

Name	Type	Use	Default	Fixed	Annotation
ViewAs	xs:string

element OutputChildren/ImageList/Items/Image/Source

diagram
children	Url Key Resource

element OutputChildren/ImageList/Items/Image/Source/Url

diagram

children

element OutputChildren/ImageList/Items/Image/Source/Key

The key for the image as an expression (e.g. a variable name)

element OutputChildren/ImageList/Items/Image/Source/Resource

The resource name as an expression (e.g. a variable name)

element OutputChildren/ImageList/Items/Image/AltText

diagram

children

annotation

documentation	Altername text, sets the alt text of the image (this is for accessability), if not specified and a title is available, the title is used
appInfo	Sets the Alt text of the image (for screen readers)

element OutputChildren/ImageList/Items/Image/Title

diagram

children

annotation

documentation	Title of the image, shown when the image is opened
appInfo	Title of the image, shown when the image isi opened

element OutputChildren/ImageList/Size

diagram

children

annotation

documentation	Altername text, sets the alt text of the image (this is for accessability), if not specified and a title is available, the title is used
appInfo	Sets the Alt text of the image (for screen readers)

element OutputChildren/Link

diagram

children

Postback Call CrLf Cs CsScript Js Do Sp Random ReDo Recursive Visit FailByBuffer Not DocxToPdf DocxToDocx XlsxToXlsx List Error AutoCorrect StrComp IntComp NBSpace IfBlock VBNet Write Get Copy Exists IsEmpty Delete DeleteAll Set Bind Peek VListPrepend VListAppend VListClear Eval Weight Replace Trim Trace LockCurrentSubject UnlockCurrentSubject SetSubject ClearSubject MetaData Chain Math Count Or And Parameter Field FloatComp UseDefine ForEachSolution Output Prompt View TextProcessor SendEmail SmsSend End StackPush Checkpoint StackPop VerifyAuthorized Language IsMatch Logout Login CreateOtpQrCode AddUser DofScript DofEvaluate Ai GetResourceKey MessagesReport

Some IM like Telegram can disable/enable the WebPreview of links in the UI

Format

xs:string

optional

element OutputChildren/Link/Postback

When true, instructs the connector to hide the postback and it's reply from the user. Use it when you need to know that the user clicked the link button but without indication in the dialog. only some connectors support this (mainly web)

annotation

documentation

Used to inform the processor that the user clicked the link (where the channel supports, like in web bot), this is optional. The processor can reply normally

element OutputChildren/Markdown

diagram

children

annotation

appInfo	text
documentation	Show the content as inline markdown

element OutputChildren/Media

diagram

children

Data Url Key File Resource Label Style Postback

attributes

Name	Type	Use	Default	Fixed	Annotation
ViewAs	xs:string	optional

element OutputChildren/Media/Data

Image data e.g. like image stored in CSS or HTML: data:image/jpg,/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAA

element OutputChildren/Media/Url

diagram

children

element OutputChildren/Media/Key

diagram

children

element OutputChildren/Media/File

diagram

children

element OutputChildren/Media/Resource

diagram

children

element OutputChildren/Media/Label

diagram

children

element OutputChildren/Media/Style

diagram

children

element OutputChildren/Media/Postback

Postback if the media is displayed as a butto, then click will send the postback

element OutputChildren/MediaButton

diagram
children	Label Completed Style Disabled Postback Content RequestedType Preprocess ResourceType

element OutputChildren/MediaButton/Label

diagram

children

element OutputChildren/MediaButton/Completed

diagram

children

element OutputChildren/MediaButton/Style

diagram

children

element OutputChildren/MediaButton/Disabled

diagram

children

element OutputChildren/MediaButton/Postback

diagram

children

element OutputChildren/MediaButton/Content

diagram
children	Data Url Key ExternalKey File Resource

element OutputChildren/MediaButton/Content/Data

Image data e.g. like image stored in CSS or HTML: data:image/jpg,/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAA

element OutputChildren/MediaButton/Content/Url

diagram

children

element OutputChildren/MediaButton/Content/Key

diagram

children

element OutputChildren/MediaButton/Content/ExternalKey

External key, e.g. youtube movie ID

element OutputChildren/MediaButton/Content/File

diagram

children

element OutputChildren/MediaButton/Content/Resource

diagram

children

element OutputChildren/MediaButton/RequestedType

Optional, if present indicate how the requested media format should be converted to, relevant when doing Preprocess and in Resource

element OutputChildren/MediaButton/Preprocess

If true, the content should be processed (e.g. fill lields), when false pass as is

element OutputChildren/MediaButton/ResourceType

Optional, if present indicate how the requested media format should be converted to, relevant when doing Preprocess and in Resource

element OutputChildren/MultiButton

diagram
children	Query Label MaxItems Postback Disabled Style Completed

element OutputChildren/MultiButton/Query

diagram

children

element OutputChildren/MultiButton/Label

diagram

children

element OutputChildren/MultiButton/MaxItems

diagram

children

element OutputChildren/MultiButton/Postback

diagram

children

element OutputChildren/MultiButton/Disabled

diagram

children

element OutputChildren/MultiButton/Style

diagram

children

element OutputChildren/MultiButton/Completed

diagram

children

element OutputChildren/MultiSelect

diagram

children

Label SubmitLabel Postback Items

attributes

Name	Type	Use	Default	Fixed	Annotation
ViewAs	xs:string	optional

element OutputChildren/MultiSelect/Label

diagram

children

element OutputChildren/MultiSelect/SubmitLabel

diagram

children

element OutputChildren/MultiSelect/Postback

diagram

children

element OutputChildren/MultiSelect/Items

diagram
children	Item

element OutputChildren/MultiSelect/Items/Item

diagram
children	Label Key

element OutputChildren/MultiSelect/Items/Item/Label

diagram

children

element OutputChildren/MultiSelect/Items/Item/Key

diagram

children

element OutputChildren/Mute

diagram

annotation

documentation

Instruct the connector to mute and not reply to the user

element OutputChildren/New

diagram

element OutputChildren/Navigate

diagram
children	Longitude Latitude Label Postback

element OutputChildren/Navigate/Longitude

diagram

children

element OutputChildren/Navigate/Latitude

diagram

children

element OutputChildren/Navigate/Label

diagram

children

element OutputChildren/Navigate/Postback

diagram

children

element OutputChildren/PathSelect

diagram
children	Label Style Columns StoreIn Query OnSelect

element OutputChildren/PathSelect/Label

diagram

children

element OutputChildren/PathSelect/Style

diagram

children

element OutputChildren/PathSelect/Columns

diagram
children	Column

element OutputChildren/PathSelect/Columns/Column

diagram
children	Header Expression Format

element OutputChildren/PathSelect/Columns/Column/Header

diagram

children

element OutputChildren/PathSelect/Columns/Column/Expression

diagram

children

element OutputChildren/PathSelect/Columns/Column/Format

diagram

children

element OutputChildren/PathSelect/StoreIn

diagram

children

element OutputChildren/PathSelect/Query

diagram

children

element OutputChildren/PathSelect/OnSelect

diagram

children

element OutputChildren/PersistentMenu

Some IM products allow a persistent menu (e.g. telegram)

element OutputChildren/PersistentMenu/MakeVisible

diagram

annotation

documentation

If supported by the channel, try and make the menu visible

element OutputChildren/Planimetry

diagram
children	Style Submit Skip Label Cancel ViewAs Header Wizard Path Reference Model

element OutputChildren/Planimetry/Style

diagram

children

element OutputChildren/Planimetry/Submit

diagram
children	Label Postback

element OutputChildren/Planimetry/Submit/Label

diagram

children

element OutputChildren/Planimetry/Submit/Postback

diagram
children	Key

element OutputChildren/Planimetry/Submit/Postback/Key

diagram

children

element OutputChildren/Planimetry/Skip

diagram
children	Label Postback

element OutputChildren/Planimetry/Skip/Label

diagram

children

element OutputChildren/Planimetry/Skip/Postback

diagram
children	Key

element OutputChildren/Planimetry/Skip/Postback/Key

diagram

children

element OutputChildren/Planimetry/Label

diagram

children

annotation

documentation	The label on the button (if in view as button mode)
appInfo	The label on the button (if in view as button mode)

element OutputChildren/Planimetry/Cancel

diagram
children	Label

element OutputChildren/Planimetry/Cancel/Label

diagram

children

element OutputChildren/Planimetry/ViewAs

diagram
children	Button Inline

element OutputChildren/Planimetry/ViewAs/Button

diagram
children	Label

element OutputChildren/Planimetry/ViewAs/Button/Label

diagram

children

element OutputChildren/Planimetry/ViewAs/Inline

diagram

element OutputChildren/Planimetry/Header

Overrides the header from the form (resource...)

element OutputChildren/Planimetry/Wizard

diagram

children

element OutputChildren/Planimetry/Path

the binding path, sice 'bind' keyword is reserved to parse, we use the 'path'

element OutputChildren/Planimetry/Reference

a json that contains reference sticker data for color correction

element OutputChildren/Planimetry/Model

a json that contains reference sticker data for color correction

element OutputChildren/Rating

diagram
children	Postback Type Levels Tip Choices

element OutputChildren/Rating/Postback

diagram

children

element OutputChildren/Rating/Type

Rating types supported are: 
        Stars,
        Mood,
        Temp,
        Health,
        Numeric0,
        Numeric1,
        ThumbUp,

element OutputChildren/Rating/Levels

diagram

children

element OutputChildren/Rating/Tip

diagram

children

element OutputChildren/Rating/Choices

diagram
children	Choice

element OutputChildren/Rating/Choices/Choice

diagram
children	Label Key

element OutputChildren/Rating/Choices/Choice/Label

diagram

children

element OutputChildren/Rating/Choices/Choice/Key

diagram

children

element OutputChildren/RatingMatrix

diagram
children	Postback Type Levels SubmitLabel Tip Choices Header Rows

element OutputChildren/RatingMatrix/Postback

diagram

children

element OutputChildren/RatingMatrix/Type

Rating types supported are: 
        Stars,
        Mood,
        Temp,
        Health,
        Numeric0,
        Numeric1,
        ThumbUp,

element OutputChildren/RatingMatrix/Levels

diagram

children

element OutputChildren/RatingMatrix/SubmitLabel

diagram

children

element OutputChildren/RatingMatrix/Tip

diagram

children

element OutputChildren/RatingMatrix/Choices

diagram
children	Choice

element OutputChildren/RatingMatrix/Choices/Choice

diagram
children	Label Key

element OutputChildren/RatingMatrix/Choices/Choice/Label

diagram

children

element OutputChildren/RatingMatrix/Choices/Choice/Key

diagram

children

element OutputChildren/RatingMatrix/Header

diagram

children

element OutputChildren/RatingMatrix/Rows

diagram
children	Row

element OutputChildren/RatingMatrix/Rows/Row

diagram
children	Label Key

element OutputChildren/RatingMatrix/Rows/Row/Label

diagram

children

element OutputChildren/RatingMatrix/Rows/Row/Key

diagram

children

element OutputChildren/Raw

Name	Type	Use	Default	Fixed	Annotation
Format	xs:string	required
ProcessInlineVariables	xs:boolean	optional

element OutputChildren/Raw/Text

diagram

children

element OutputChildren/Raw/File

diagram

children

element OutputChildren/ReOrder

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Move	xs:string	required

element OutputChildren/RequestFile

diagram

children

Postback Label Tip Accept

attributes

Name	Type	Use	Default	Fixed	Annotation
Multiple	xs:boolean	optional	false
ViewAs	xs:string	optional

annotation

documentation

Display "upload file" button, the user uploads a file, then the file location is sent as a request to the processor

element OutputChildren/RequestFile/Postback

diagram

children

element OutputChildren/RequestFile/Label

diagram

children

element OutputChildren/RequestFile/Tip

diagram

children

element OutputChildren/RequestFile/Accept

The accept attribute takes as its value a comma-separated list of one or more file types, or unique file type specifiers, describing which file types to allow.

element OutputChildren/RequestLink

A description that can be used for tooltip popup or for accessability (e.g. Title property in HTML A link)

element OutputChildren/RequestLink/Postback

diagram

children

element OutputChildren/RequestLink/Style

diagram

children

element OutputChildren/RequestLink/Completed

diagram

children

element OutputChildren/RequestLink/Disabled

diagram

children

element OutputChildren/RequestLocation

A description that can be used for tooltip popup or for accessability (e.g. Title property in HTML A link)

annotation

documentation

Request the location of the end user from the connector. Used for example in Messenger

element OutputChildren/RequestLocation/Postback

The postback on which the coordinates are added.
Most channels do not support this, supported by WebBot

element OutputChildren/RequestSignature

If supported by channel, opens a signature pad and allows the user to draw thweir signature.

element OutputChildren/RequestSignature/Postback

diagram

children

element OutputChildren/RequestSignature/Label

diagram

children

element OutputChildren/RequestSignature/Tip

diagram

children

element OutputChildren/SectionBreak

diagram

element OutputChildren/Select

Name	Type	Use	Default	Fixed	Annotation
ViewAs	xs:string	optional

element OutputChildren/Select/Postback

diagram

children

element OutputChildren/Select/Items

diagram
children	Item

element OutputChildren/Select/Items/Item

diagram
children	Label Key Postback

element OutputChildren/Select/Items/Item/Label

diagram

children

element OutputChildren/Select/Items/Item/Key

If specified, the text here is appended as text to the key (separated)

element OutputChildren/Select/Items/Item/Postback

diagram

children

element OutputChildren/Separator

diagram
children	Style

element OutputChildren/Separator/Style

diagram

children

element OutputChildren/SetIntent

diagram

children

element OutputChildren/SetSubject

diagram

children

element OutputChildren/SetSummary

diagram

children

element OutputChildren/SetResult

Sets the result flag/tag. Usually set one of the following values:
OK, UnrecognizedText, UnrecognizedWords, Invalid, Error, Warning

element OutputChildren/Text

Instruct the display to use monospace font, useful for displaying text tables and lists

text

element OutputChildren/RequestPicture

Name	Type	Use	Default	Fixed	Annotation
ViewAs	xs:string	optional
Multiple	xs:boolean	optional	false

annotation

documentation

If supported by channel, opens the camera app and allows the user to take one picture.

element OutputChildren/RequestPicture/Postback

diagram

children

element OutputChildren/RequestPicture/Label

diagram

children

element OutputChildren/RequestPicture/Tip

diagram

children

element OutputChildren/Video

diagram

children

Type Key Label Postback

attributes

Name	Type	Use	Default	Fixed	Annotation
ViewAs	xs:string	optional

annotation

documentation

Embedded video

element OutputChildren/Video/Type

diagram

children

element OutputChildren/Video/Key

diagram

children

element OutputChildren/Video/Label

diagram

children

element OutputChildren/Video/Postback

diagram

children

element OutputChildren/VList

diagram

children

Name Separator Bullet

attributes

Name	Type	Use	Default	Fixed	Annotation
Format	xs:string	required

annotation

documentation

A simple stack (LIFO) where you can push an pop values, the stack is stored in location specified by name. To use simply call StackPush with the storage location and write to the buffer, the buffer will be stored in the stack for later use.

element OutputChildren/VList/Name

diagram

children

element OutputChildren/VList/Separator

diagram

children

element OutputChildren/VList/Bullet

diagram

children

element OutputChildren/VegaLite

diagram
children	Code Size Data DataSizeThreshold

element OutputChildren/VegaLite/Code

diagram
children	Json

element OutputChildren/VegaLite/Code/Json

diagram

children

element OutputChildren/VegaLite/Size

diagram

children

annotation

documentation	Altername text, sets the alt text of the image (this is for accessability), if not specified and a title is available, the title is used
appInfo	Sets the Alt text of the image (for screen readers)

element OutputChildren/VegaLite/Data

diagram
children	VarQuery

element OutputChildren/VegaLite/Data/VarQuery

diagram
children	Columns Query

element OutputChildren/VegaLite/Data/VarQuery/Columns

diagram
children	Column

element OutputChildren/VegaLite/Data/VarQuery/Columns/Column

diagram
children	Name Expression

element OutputChildren/VegaLite/Data/VarQuery/Columns/Column/Name

diagram

children

element OutputChildren/VegaLite/Data/VarQuery/Columns/Column/Expression

diagram

children

element OutputChildren/VegaLite/Data/VarQuery/Query

diagram

children

element OutputChildren/VegaLite/DataSizeThreshold

Minimum (inclusive) amount of datapoints to show the graph, numeric value e.g.

element OutputChildren/InternalUse

diagram

children

Output_ReOrder Output_PathSelect Output_BarcodeScanButton Output_SetIntent Output_SetSubject Output_Text Output_SetSummary Output_New Output_Clear Output_Header Output_CRLF Output_Form Output_FormPostback Output_Link Output_RequestLocation Output_RequestFile Output_RequestLink Output_RequestPicture Output_RequestSignature Output_Planimetry Output_Image Output_ImageList Output_PersistentMenu_MakeVisible Output_Custom Output_SetResult Output_Media Output_MediaButton Output_Select Output_Mute Output_Group Output_SectionBreak Output_Dialer Output_Navigate Output_Markdown Output_Video Output_Html Output_RatingMatrix Output_Rating Output_MultiSelect Output_Raw Output_VegaLite Output_VList Output_Separator Output_MultiButton

annotation

appInfo	true
documentation	For internal use, each output child has a direct replacement to skip the "output" level

element OutputChildren/InternalUse/Output_ReOrder

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_PathSelect

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_BarcodeScanButton

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_SetIntent

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_SetSubject

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_Text

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_SetSummary

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_New

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_Clear

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_Header

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_CRLF

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_Form

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_FormPostback

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_Link

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_RequestLocation

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_RequestFile

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_RequestLink

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_RequestPicture

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_RequestSignature

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_Planimetry

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_Image

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_ImageList

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_PersistentMenu_MakeVisible

diagram

annotation

appInfo	true
documentation	Used by compiler as shortcut for Output-Text...

element OutputChildren/InternalUse/Output_Custom

diagram

element OutputChildren/InternalUse/Output_SetResult

diagram

element OutputChildren/InternalUse/Output_Media

diagram

element OutputChildren/InternalUse/Output_MediaButton

diagram

element OutputChildren/InternalUse/Output_Select

diagram

element OutputChildren/InternalUse/Output_Mute

diagram

element OutputChildren/InternalUse/Output_Group

diagram

element OutputChildren/InternalUse/Output_SectionBreak

diagram

element OutputChildren/InternalUse/Output_Dialer

diagram

element OutputChildren/InternalUse/Output_Navigate

diagram

element OutputChildren/InternalUse/Output_Markdown

diagram

element OutputChildren/InternalUse/Output_Video

diagram

element OutputChildren/InternalUse/Output_Html

diagram

element OutputChildren/InternalUse/Output_RatingMatrix

diagram

element OutputChildren/InternalUse/Output_Rating

diagram

element OutputChildren/InternalUse/Output_MultiSelect

diagram

element OutputChildren/InternalUse/Output_Raw

diagram

element OutputChildren/InternalUse/Output_VegaLite

diagram

element OutputChildren/InternalUse/Output_VList

diagram

element OutputChildren/InternalUse/Output_Separator

diagram

element OutputChildren/InternalUse/Output_MultiButton

diagram

group ParseChild

diagram
children	Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language

element ParseChild/Fit

diagram

children

Value TrimBegin TrimEnd

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

MatchType

documentation	Specifies a matching algorithem, ranging from Fixed character to character exact match to Metaphonetic limited by the total number of character mismached
appInfo	like
appInfo	true
appInfo	Specifes matching algorithem.

Tolerance

optional

documentation	Specifies the number of changes between two tokens. A change is a replacement deletion or insert of a single character.
appInfo	tolerance

tolerancemethod

MaxTolerance

optional

documentation

Specify maximum tolerance in case of variable tolerance method (e.g Linear)

annotation

documentation	Fit is the basic parsing command. It includes at least one symbolic value that is matched to the input string. It may correspond to a text portion of the mask, or to an asterisk (wildcard). Fit may also be optional.
appInfo	Fit - Match input token(s) to a list of values
appInfo	fit
appInfo	true
appInfo	Match

element ParseChild/Fit/Value

([^\x20].*[^\x20])|[^\x20]

annotation

appInfo	value
appInfo	true

element ParseChild/Free

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	FREE in parse refers to any possible value, limited by words count and terminators. The value from FREE can be stored in a variable if the child element SET is specified.
appInfo	Allow any token(s) to be selected
appInfo	free
appInfo	true

element ParseChild/List

diagram

children

Column TrimBegin TrimEnd

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

Name

list_name

required

documentation	Name of a list to be used as a mach to input token.
appInfo	name of a list clause
appInfo	listnode
appInfo	name

Tolerance

optional

documentation	Specifies the number of changes between two tokens. A change is a replacement deletion or insert of a single character.
appInfo	tolerance

tolerancemethod

MaxTolerance

optional

documentation

Specify maximum tolerance in case of variable tolerance method (e.g Linear)

BindingModel

optional

annotation

documentation	Tries to match input token to one of the keys in the list named.
appInfo	List - Match a key in specified list to input token(s)
appInfo	list
appInfo	true

element ParseChild/List/Column

diagram

type

extension of xs:QName

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Index_Hide

xs:int

optional

documentation	Used internally for index of the column in the list declaration
appInfo	false

element ParseChild/Like

diagram

children

Value TrimBegin TrimEnd

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	Match the pattern (wildcard) against the string (fixed): match(string, pattern, ignore_case); returns TRUE if string matches pattern, FALSE otherwise. In the pattern: `' matches any sequence of characters (zero or more) `?' matches any single character [SET] matches any character in the specified set, [!SET] or [^SET] matches any character not in the specified set. A set is composed of characters or ranges; a range looks like ``character hyphen character'' (as in 0-9 or A-Z). [0-9a-zA-Z_] is the minimal set of characters allowed in the [..] pattern construct. Other characters are allowed (i.e., 8-bit characters) if your system will support them. To suppress the special syntactic significance of any of ``[]?!^-\'', in- side or outside a [..] construct, and match the character exactly, precede it with a ``\'' (backslash).
appInfo	Fit - 'Like' operator input token(s) to a list of values
appInfo	like
appInfo	true
appInfo	Match

element ParseChild/Like/Value

diagram

type

restriction of xs:string

annotation

appInfo	value
appInfo	true

element ParseChild/Integer

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

Min

IntegerOrVariable

optional

documentation	A minimum value (including) that is allowed for the integer
appInfo	A minimum value (including) that is allowed for the integer
appInfo	min
appInfo	true

Max

IntegerOrVariable

optional

documentation	Maximum value allowed for the integer (including)
appInfo	Maximum value allowed for the integer (including)
appInfo	max
appInfo	true

documentation	Match an integer in a numeric form (i.e. 1,2,3,4...)
appInfo	Integer - Match an integer in a numeric form (i.e. 1,2,3,4...)
appInfo	integer
appInfo	true
appInfo	numeric

element ParseChild/Float

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

Min

xs:float

optional

documentation	Minimum value (including) for the numeric value
appInfo	Minimum value (including) for the numeric value
appInfo	min
appInfo	true

Max

xs:float

optional

documentation	Maximum value (including) for the numeric value
appInfo	Maximum value (including) for the numeric value
appInfo	max
appInfo	true

annotation

documentation	Matches an a floating point number (e.g. 1.2, 2.0 , -33.9 ...)
appInfo	Match an a floating point number (e.g. 1.2, 2.0 , -33.9 ...)
appInfo	float
appInfo	true
appInfo	numeric

element ParseChild/Not

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language TrimBegin TrimEnd

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	Not will succeed only if it's child has failed. use it when you want to spesify that a specific token is not allowed. Not will never keep it's children variables.
appInfo	Not - Inverts the status of it's child
appInfo	not
appInfo	true
appInfo	Logic

element ParseChild/And

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	And allows testing more than a single alternative when parsing user input. Each child of the And is tested seperately to match the input text. All children of And must succeed to allow And itself to succeed.
appInfo	And - Match all of the children to input token(s)
appInfo	and
appInfo	true
appInfo	Logic

element ParseChild/And/VBNetTest

A VBNet that can't bind or peek variables and also doesn't get the Current string as argument. Use this in cases where speed is importent like a repetative script that tests a global variable

element ParseChild/Best

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	Best allows testing more than a single alternative when parsing user input. Each child of the Best is tested seperately to match the input text. The best scrored child to match the input will be used, thus the order of children in best is not meaningful.
appInfo	Match the best child to input token(s)
appInfo	best
appInfo	true
appInfo	Logic

element ParseChild/Or

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	Or allows testing more than a single alternative when parsing user input. Each child of the Or is tested seperately to match the input text. The first child to match the input will be used, thus the order of children in OR is meaningful.
appInfo	Or - Match one of children to input token(s)
appInfo	or
appInfo	true
appInfo	Logic

element ParseChild/Shortcut

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	Compares the input token to the existing list of shortcuts
appInfo	shortcut
appInfo	Compares the input token to the existing list of shortcuts

element ParseChild/Get

diagram

type

extension of VariableName

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	Gets the value of a variable. The Get keyword changes its function depending on its location in the clause: In Do the Get retrieves a variable value for the output sink (i.e., write). In Parse it is used to symbolically match a value to a variable.
appInfo	Retrieves the value of a variable
appInfo	get
appInfo	Variables

element ParseChild/Drop

diagram

type

extension of TerminatorRanges

facets

pattern	((english\|hebrew\|digit\|space\|math\|symbol\|LF\|CR\|.) +)*(english\|hebrew\|digit\|space\|math\|symbol\|LF\|CR\|.)
pattern	notspace
pattern	any

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation

Consume the specified characters until the first character not in the list. this command can cause CACHE issues if used first in a rule (even after optional)

appInfo

Consume the specified characters until the first character not in the list

appInfo

drop

element ParseChild/Call

diagram

children

Map TrimBegin TrimEnd

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

Name

parse_name

required

appInfo	name
appInfo	RULENODE

documentation	Used for inhibiting the cache on call, used by the compiler in permutations
appInfo	true

OnMissing

OnMissingType

optional

documentation	If the reference is missing, what to do
appInfo	If the called element is not found, throw a compiler error, or the Call element will be replaced with Fail element

Index

xs:string

optional

documentation	For internal use
appInfo	true

Max weight (including 'Weight' attribute) alloed in this call, if weght is larger the call will fail as Unknown (as the processor can't know if longer shorter string will work)

annotation

documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true
documentation	Tries to match the input token to a complete parse procedure.
appInfo	Inline - Match input token(s) to Parse defined elsewhere in the code
appInfo	inline
appInfo	true

element ParseChild/Call/Map

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	parse_name	required
As	xs:string	required

element ParseChild/Parse

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

documentation	Store the bind text.
appInfo	Store the bind text
appInfo	StoreTokenInBind
appInfo	true

annotation

documentation	Parse command within parse procedure allows grouping of a set of clauses that are treated as a single larger element. In this context parse may be used alone, or to allow the parser to test a sequence of elements.
appInfo	parse
appInfo	Group a sequence of parsing elements
appInfo	true

element ParseChild/ParseGreedy

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language

annotation

documentation	Parse command within parse procedure allows grouping of a set of clauses that are treated as a single larger element. In this context parse may be used alone, or to allow the parser to test a sequence of elements.
appInfo	parse
appInfo	Group a sequence of parsing elements
appInfo	true

element ParseChild/Test

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation	Test is used to minimize the variable collection by dropping all the varaibales generated below it. other than that it behaves exactly like regular Parse
appInfo	Test
appInfo	Test is used to minimize the variable collection by dropping all the varaibales generated below it.
appInfo	true

element ParseChild/Test/Do

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

annotation

documentation	Do acts as the RHS part of patterns, it instructs the execution of its children and returns the output. Do will execute all the children whether sucessful or not.
appInfo	Execute a list of actions
appInfo	do
appInfo	true

element ParseChild/Regex

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation

Matches regular expression, multiple values are 'ored' using |

element ParseChild/Regex/Value

diagram

type

restriction of xs:string

annotation

documentation	RegEx expression, if you want to match the entire string don't forget to add ^ on start and $ on the end of the pattern
appInfo	value
appInfo	true

element ParseChild/Peek

diagram

type

TempVariablePathWithMember

facets

pattern

^([a-zA-Z][a-zA-Z0-9_:]*/)*[a-zA-Z][a-zA-Z0-9_:]*[.](text|value|weight|key)\z

annotation

documentation	Retrieves the current value of the variable that could be bounded to a parse element. The value retrieved is the current value of the variable when accessed; this is not neccesarily the value of the variable when the parse is completed.
appInfo	Peeks the current value of a temporary bounded variable.
appInfo	true
appInfo	peek
appInfo	Variables

element ParseChild/ParseAll

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

element ParseChild/OrAll

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language Do

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

BindingModel

optional

element ParseChild/OrAll/Do

diagram

children

Delete DeleteAll Write Do IfBlock Get Peek Bind List Count VBNet IsEmpty Exists Field Trace Not StrComp Sp Set Weight ShortcutsApply

annotation

documentation	Do acts as the RHS part of patterns, it instructs the execution of its children and returns the output. Do will execute all the children whether sucessful or not.
appInfo	Execute a list of actions
appInfo	do
appInfo	true

element ParseChild/Fail

diagram

annotation

documentation	Fails the compare no matter whats the value
appInfo	Fails the compare no matter whats the value

element ParseChild/Language

diagram
children	On

element ParseChild/Language/On

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language

attributes

Name	Type	Use	Default	Fixed	Annotation
Language	Language	required

group ParseChildren

diagram

children

Fit Free List Like Integer Float Not And Best Or Shortcut Get Drop Call Parse ParseGreedy Test ParseBest ParsePermutations Regex Peek VBNetParse CsParse ParseAll OrAll Contains Fail Match Language Do

annotation

documentation

A group off all commands available in parse

element ParseChildren/Do

diagram

children

annotation

documentation	Do acts as the RHS part of patterns, it instructs the execution of its children and returns the output. Do will execute all the children whether sucessful or not.
appInfo	Execute a list of actions
appInfo	do
appInfo	true

group ParseTerminators

diagram
children	TrimBegin TrimEnd

element ParseTerminators/TrimBegin

diagram

type

restriction of xs:string

annotation

documentation	Allows trimming the begining of the token before it is matched with the parse command. If bind is used then the value stored is after the trim_begin. trim_begin is activated only once with the first applicable element.
appInfo	Remove strings from the begining of the token
appInfo	trim_begin
appInfo	true
appInfo	parse/fit/trim_begin

element ParseTerminators/TrimEnd

diagram

type

restriction of xs:string

annotation

documentation	Allows trimming the end of the token befor it is matched with the parse command. If bind is used then the value stored is after the trim_begin. trim_end is activated only once with the first applicable element.
appInfo	true
appInfo	trim_end
appInfo	Removes strings from the end of the token
appInfo	parse/fit/trim_end

group PreTestChildren

diagram

children

And Or Not VBNetRequire CsRequire Weight Exists IsEmpty Contains

annotation

documentation

A group of elements that contains all the possible elements in a test node.

element PreTestChildren/And

diagram

children

And Or Not VBNetRequire CsRequire Weight Exists IsEmpty Contains

annotation

documentation	returns true only if all chikldren are sucessfull
appInfo	and
appInfo	true
appInfo	Sucsseeds if all children sucsseed as well

element PreTestChildren/Or

diagram

children

And Or Not VBNetRequire CsRequire Weight Exists IsEmpty Contains

annotation

documentation	Performs a logical or on it's child nodes, that is succeeds if at least one of it's children returns true. Or must have at least two child nodes.
appInfo	or
appInfo	true
appInfo	Perform logical or on it's child nodes

element PreTestChildren/Not

diagram

children

And Or Not VBNetRequire CsRequire Weight Exists IsEmpty Contains

annotation

documentation	Invert the status of the child nodes
appInfo	Invert the status of the child nodes
appInfo	true
appInfo	not

element PreTestChildren/Contains

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	VariableName	required

annotation

documentation	checks if a variable contains the specified value
appInfo	checks if a variable contains the specified value

group TextProcessor_Filters

diagram
children	Filters

element TextProcessor_Filters/Filters

diagram
children	Synonym FullLengthSynonym Replace FilterHebrewStandard TokensProperties FilterEnglishStemmer FilterStopWords FilterHebrewStopWords FilterEnglishStopWords ChineseScript

element TextProcessor_Filters/Filters/Synonym

documentation	Specifies a matching algorithem, ranging from Fixed character to character exact match to Metaphonetic limited by the total number of character mismached
appInfo	like
appInfo	true
appInfo	Specifes matching algorithem.

Tolerance

optional

documentation	Specifies the number of changes between two tokens. A change is a replacement deletion or insert of a single character.
appInfo	tolerance

tolerancemethod

MaxTolerance

optional

documentation

Specify maximum tolerance in case of variable tolerance method (e.g Linear)

Setting to apply the Tokenizer from the text  processor (load/search) on every list key

annotation

appInfo

Local synonyms, must be first filter

element TextProcessor_Filters/Filters/Synonym/DataSource

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	list_name	required
TokenColumnName	xs:string	required
SynonymColumnName	xs:string	required
WeightColumnName	xs:string	optional

element TextProcessor_Filters/Filters/Synonym/List

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	list_name	required

element TextProcessor_Filters/Filters/FullLengthSynonym

documentation	Specifies a matching algorithem, ranging from Fixed character to character exact match to Metaphonetic limited by the total number of character mismached
appInfo	like
appInfo	true
appInfo	Specifes matching algorithem.

Tolerance

optional

documentation	Specifies the number of changes between two tokens. A change is a replacement deletion or insert of a single character.
appInfo	tolerance

tolerancemethod

MaxTolerance

optional

documentation

Specify maximum tolerance in case of variable tolerance method (e.g Linear)

Setting to apply the Tokenizer from the text  processor (load/search) on every list key

annotation

appInfo	Local synonyms, must be first filter
documentation	Provide synonym for the entire text (in short to medium lists like Flex). This has no limit on the size and faster than regular synonym

element TextProcessor_Filters/Filters/FullLengthSynonym/DataSource

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	list_name	required
TokenColumnName	xs:string	required
SynonymColumnName	xs:string	required
WeightColumnName	xs:string	required

element TextProcessor_Filters/Filters/FullLengthSynonym/List

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	list_name	required

element TextProcessor_Filters/Filters/Replace

Local synonyms, must be first filter

element TextProcessor_Filters/Filters/Replace/DataSource

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	list_name	required
TokenColumnName	xs:string	required
ReplaceWithColumnName	xs:string	required
WeightColumnName	xs:string	optional

element TextProcessor_Filters/Filters/FilterHebrewStandard

Name	Type	Use	Default	Fixed	Annotation
Morphing	xs:string	optional

element TextProcessor_Filters/Filters/FilterHebrewStandard/LematizeOptions

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
PrefixCostFactor	unsignedDouble	required
MorphCostFactor	unsignedDouble	required
CumulativeTolerancePerChar	unsignedDouble	required
MaxTolerance	unsignedDouble	required
MaxCost	unsignedDouble	required
ToleranceCostFactor	unsignedDouble	required

element TextProcessor_Filters/Filters/TokensProperties

diagram

children

DefaultToken PropertiesByFilter List

documentation	If true, duplicate word properties are overwritten by the last value
documentation	If true, duplicate word properties are overwritten by the last value
appInfo	allowduplicatekeys

element TextProcessor_Filters/Filters/TokensProperties/DefaultToken

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Optional	xs:boolean
ProhibitLastWord	xs:boolean
ProhibitFirstWord	xs:boolean
IsSupporting	xs:boolean

element TextProcessor_Filters/Filters/TokensProperties/PropertiesByFilter

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Optional	xs:boolean
ProhibitLastWord	xs:boolean
ProhibitFirstWord	xs:boolean
IsSupporting	xs:boolean
RegExFilter	xs:string	required

element TextProcessor_Filters/Filters/TokensProperties/List

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	list_name	required

element TextProcessor_Filters/Filters/FilterEnglishStemmer

diagram

element TextProcessor_Filters/Filters/FilterStopWords

Name	Type	Use	Default	Fixed	Annotation
DropTokenCost	unsignedDouble	optional	0.0
Transform	xs:string	optional
MarkStopWordsAsSupport	xs:boolean	optional	true

element TextProcessor_Filters/Filters/FilterStopWords/DataSource

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
Name	list_name	required
TokenColumnName	xs:string	required
WeightColumnName	xs:string	required

element TextProcessor_Filters/Filters/FilterHebrewStopWords

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
DropTokenCost	unsignedDouble	optional	0.0
Transform	xs:string	optional
MarkStopWordsAsSupport	xs:boolean	optional	true

element TextProcessor_Filters/Filters/FilterEnglishStopWords

diagram

attributes

Name	Type	Use	Default	Fixed	Annotation
DropTokenCost	unsignedDouble	optional	0.0
Transform	xs:string	optional
MarkStopWordsAsSupport	xs:boolean	optional	true

element TextProcessor_Filters/Filters/ChineseScript

Convert Traditional to Simplified chinese and vise versa.

group TextProcessor_Tokenizer

diagram
children	Tokenizer

element TextProcessor_Tokenizer/Tokenizer

diagram
children	StandardTokenizer SmartChineseTokenizer

element TextProcessor_Tokenizer/Tokenizer/StandardTokenizer

note that double quotes can also be handled by SmartDoubleQuotes

Try to correctly decide which " is separator and which is not and user as Acronyms.

element TextProcessor_Tokenizer/Tokenizer/SmartChineseTokenizer

diagram

complexType MixedValue

diagram

children

complexType TextProcessorType

diagram
children	Tokenizer Filters

attributeGroup BindingModel

attributes

Name	Type	Use	Default	Fixed	Annotation
BindingModel	BindingModel	optional

annotation

documentation

How to return multiple records, options are the default Switch (that generates switch between the results, then broken to multiple solutions by AmlSolutions) or as list that is handled as a single solution (with one weight)

attributeGroup ClauseID

documentation	Used to hold the path of the clause in the compiler
appInfo	true

attributeGroup DisableClause

documentation	Defines if the clause will be compiled
appInfo	true
appInfo	disabled
appInfo	Prevents the item to be compiled

attributeGroup Distance

documentation	Defines the maximum steps that the parser will perform using the specified relation (e.g. Holonym) from the sense in order to reach the input word.
appInfo	true
appInfo	Maximum steps from Sense to word
appInfo	distance

attributeGroup DoCommonFormating
attributeGroup DoProperties

attributes

Name

Type

Use

Default

Fixed

Annotation

Link

xs:string

optional

documentation	Use link to set a sentence that will be used as input if the user selects the text enclosed within the DO. Link is a lot like the HTML href tag, but instead of refering to an HTML page, it is a semantic link that links to an input from the user.
appInfo	true
appInfo	link
appInfo	Sets a semantic link for the enclused text

attributeGroup FlexListTokenAttributes

attributes

Name	Type	Use	Default	Fixed	Annotation
Optional	xs:boolean
ProhibitLastWord	xs:boolean
ProhibitFirstWord	xs:boolean
IsSupporting	xs:boolean

Instruct the compiler how to handle unreferenced item (e.g. data base connection) 'always' will keep the clause even if it is not referenced anywhere else. Use this when you reference clause by name like accessing connection by name.

The mask is the sentence structure to be matched to the input.  
An asterisk indicates a "wildcard", i.e. several possible words or phrases.
The parse command will attempt to fit each portion of the mask to the input.

appInfo

mask

appInfo

true

attributeGroup MaskBegin

attributes

Name	Type	Use	Default	Fixed	Annotation
MaskBegin	xs:string	required

annotation

documentation

begin of the pattern

attributeGroup MaskEnd

attributes

Name	Type	Use	Default	Fixed	Annotation
MaskEnd	xs:string	required

annotation

documentation

begin of the pattern

attributeGroup MaskLike

attributes

Name	Type	Use	Default	Fixed	Annotation
MaskLike	xs:string	required

annotation

documentation

begin of the pattern

attributeGroup MatchTolerance

documentation	Specifies the number of changes between two tokens. A change is a replacement deletion or insert of a single character.
appInfo	tolerance

tolerancemethod

MaxTolerance

optional

documentation

Specify maximum tolerance in case of variable tolerance method (e.g Linear)

annotation

documentation	Specifies the number of changes between two tokens. A change is a replacement deletion or insert of a single character.
appInfo	Number of changes between two tokens
appInfo	attribute

attributeGroup MatchType

documentation	Specifies a matching algorithem, ranging from Fixed character to character exact match to Metaphonetic limited by the total number of character mismached
appInfo	like
appInfo	true
appInfo	Specifes matching algorithem.

annotation

documentation	Match type specifies the algorithm used to compare tokens with the parse element. For 'Fixed' the compare is character by character and all characters must be identical. Other algorithms allows a more fuzzy compare like phonetic compare.
appInfo	Specifies the matching algorithm used
appInfo	matchtype
appInfo	true

attributeGroup Private

documentation	Specifies if the item is private, that is, only clauses from the same file may reference it.
appInfo	true
appInfo	private
appInfo	Specifies if the item is private, that is, only clauses from the same file may reference it.

documentation	A long number specifying a sense number. The sense number may be followed by a description that is ignored by the compiler.
appInfo	sense
appInfo	Sense number follwed by description.
appInfo	true

attributeGroup StopWordsFilterCommon

attributes

Name	Type	Use	Default	Fixed	Annotation
DropTokenCost	unsignedDouble	optional	0.0
Transform	xs:string	optional
MarkStopWordsAsSupport	xs:boolean	optional	true

attributeGroup Top

attributes

Name	Type	Use	Default	Fixed	Annotation
Top	xs:positiveInteger	optional	1

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxChar

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

MinWords

xs:unsignedInt

optional

documentation	Sets the minimum number of words that can match this element.
appInfo	Specify minimum number of tokens to match in parse element
appInfo	min_words
appInfo	true

MaxWords

xs:unsignedInt

optional

documentation	Sets the maximum number of words that can match this element.
appInfo	Specify maximum number of tokens to match in parse element
appInfo	max_words
appInfo	true

documentation	Specifies that the element is optional. (Note: this is not the same as setting min_words = 0.)
appInfo	Allow the parse element to be ignored
appInfo	optional
appInfo	true

terminator

documentation	Specifies that the terminator is dropped when the parser advances to the next token or when the parser starts the next token from the "including-the- terminator" character: Terminator_drop allows the parser to parse phrases like "4+4", where "+" is detected by the terminator and is then handled by the next parse command. include_terminator values: True: The terminator is dropped False: The terminator is joined with the next token.
appInfo	terminator_include
appInfo	true
appInfo	Keep/Drop the terminator for use in next element

Bind

TempVariableName

optional

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

Weight

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float or vb Const
appInfo	weight


          TrimMode specifies how the system will handle the Trim streings:
          Normal- Try to solve without trimming, of successful then stop else try to trim.
          Prefere- First trim the string then try to solve, only if not successful then try nontrimmed string.
          Force- Allow only to trim.
          All - 
          Best -

appInfo

trim_mode

TrimBind

TempVariableName

optional

appInfo	bind
appInfo	true

TrimWeight

xs:float

optional

documentation	Used to overwrite the built-in sub weight calculation. values are 0 to 1 as float
appInfo	weight

annotation

documentation

A collection of attributes used to specify a specific Parse element this includes:
Mminimum and maximum number of words to be used in this comparison and a binary value to specify if the whole element is optional.

attributeGroup words_bind

documentation	Name of a temporary variable (excluding the "/temp" prefix) that will be bounded to the token matched by the parsing element. This variable may hold several different values while the parser tries to resolve the input. When using 'bind' no complex variables are allowed, that is you can not use pointers references, randoms or '[' symbols.
appInfo	bind
appInfo	Name of a temporary variable excluding the "/temp" prefix
appInfo	true

attributeGroup words_language

documentation	Specifies that this element should be used only for compilation in the specified language
appInfo	element
appInfo	false
appInfo	Specifies compilation in the specified language

annotation

documentation

A collection of attributes used to specify a specific Parse element this includes:
Mminimum and maximum number of words to be used in this comparison and a binary value to specify if the whole element is optional.

XML Schema documentation generated with XML Spy Schema Editor www.xmlspy.com