NSFreeTextAgent - SuperOffice

This agent can be used to manage the free text system.

Constructors

NSFreeTextAgent()

NSFreeTextAgent

This agent can be used to manage the free text system.

Methods

AddWords(String)

Adds the words in the string to the stop word list

Void AddWords(String stopWords)

Returns: CRMScript.Global.Void Example:

NSFreeTextAgent agent;
String stopWords;
agent.AddWords(stopWords);

DeleteStopWordsById(Integer[])

Deletes the stop words with these IDs

Void DeleteStopWordsById(Integer[] stopWordIds)

Returns: CRMScript.Global.Void Example:

NSFreeTextAgent agent;
Integer[] stopWordIds;
agent.DeleteStopWordsById(stopWordIds);

GetStatus()

Returns status for the free-text search words

NSFreeText GetStatus()

Returns: CRMScript.NetServer.NSFreeText Example:

NSFreeTextAgent agent;
NSFreeText res = agent.GetStatus();

GetStopWordList()

Returns the list of stop words

String[] GetStopWordList()

Returns: CRMScript.Global.String[] - list of stop words. Example:

NSFreeTextAgent agent;
String[] res = agent.GetStopWordList();

GetSuggestedStopWords(Integer)

Returns the top used words in the free-text index table, sorted as most used first

NSMDOListItem[] GetSuggestedStopWords(Integer countWords)

Returns: CRMScript.NetServer.NSMDOListItem[] Example:

NSFreeTextAgent agent;
Integer countWords;
NSMDOListItem[] res = agent.GetSuggestedStopWords(countWords);

RegenerateIndex(Bool)

Wipes and regenerates the free-text index by scanning the database (free-text search will be unavailable while this operation runs

NSBatchTaskInfo RegenerateIndex(Bool runAsBatch)

Returns: CRMScript.NetServer.NSBatchTaskInfo Example:

NSFreeTextAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateIndex(runAsBatch);

SetAutoEnableTravelAreas(Bool)

Void SetAutoEnableTravelAreas(Bool autoEnable)

Returns: CRMScript.Global.Void Example:

NSFreeTextAgent agent;
Bool autoEnable;
agent.SetAutoEnableTravelAreas(autoEnable);

SetEnabled(Bool)

Sets free-text search to enabled (true) or disabled (false)

Void SetEnabled(Bool enabled)

Returns: CRMScript.Global.Void Example:

NSFreeTextAgent agent;
Bool enabled;
agent.SetEnabled(enabled);

SetMultiWordOperator(Integer)

Sets the operator used when matching multiple words

Void SetMultiWordOperator(Integer freeTextOperator)

Returns: CRMScript.Global.Void Example:

NSFreeTextAgent agent;
Integer freeTextOperator;
agent.SetMultiWordOperator(freeTextOperator);

SetSingleWordOperator(Integer)

Sets the operator used when matching single words

Void SetSingleWordOperator(Integer freeTextOperator)

Returns: CRMScript.Global.Void Example:

NSFreeTextAgent agent;
Integer freeTextOperator;
agent.SetSingleWordOperator(freeTextOperator);

​Constructors

​NSFreeTextAgent()

​Methods

​AddWords(String)

​DeleteStopWordsById(Integer[])

​GetStatus()

​GetStopWordList()

​GetSuggestedStopWords(Integer)

​RegenerateIndex(Bool)

​SetAutoEnableTravelAreas(Bool)

​SetEnabled(Bool)

​SetMultiWordOperator(Integer)

​SetSingleWordOperator(Integer)

Constructors

NSFreeTextAgent()

Methods

AddWords(String)

DeleteStopWordsById(Integer[])

GetStatus()

GetStopWordList()

GetSuggestedStopWords(Integer)

RegenerateIndex(Bool)

SetAutoEnableTravelAreas(Bool)

SetEnabled(Bool)

SetMultiWordOperator(Integer)

SetSingleWordOperator(Integer)