CasewareDocs

SimpleCommands

The Simple Commands type exposes the following members:

Members of Simple Commands
Command Description
CheckAccessRights Checks the access rights of a specific directory.
ColognePhonetics The function implements the cologne phonetics algorithm.
CreateActionField Creates an action field link to display the extraction preview.
CreateActionFieldForScript Creates an action field for executing an IDEAScript.
CreateResultObject Creates a result to be added to the results collection.
CreateUniqueFileInProjectLibrary Creates a file with unique name within IDEA project library folder.
DatabaseExtension Returns the extension of IDEA databases.
DateAdd This function allows to add any number of intervals of any size to a date / time value.
DateMask Gets the default IDEA date mask.
DaySymbol Gets the default IDEA day symbol.
Dbl2IdeaStr The function converts a double value into a valid string within an IDEA equation.
DeleteDatabase Deletes the database without corrupting the database header before the database is deleted.
DeleteField Deletes an IDEA field by name.
DeleteFilePeriod Deletes global parameter for the field.
DeleteFolderPeriod Deletes global parameter for the folder.
FieldExists Searches for a field inside an IDEA database.
FileExists Checks existence of IDEA database.
FileIsValid Tests if a file is valid (exists and contains at least one record).
FormatString Replaces placeholders in a given string.
Get4AuditFolder Returns the list of audit folders within the current IDEA working folder.
GetKnownLocationPath Record definition files should be added to an app definition as auxiliary files. During the import such files get deployed into a well-known location of SmartAnalyzer. This macro command obtains the path of such a location.
GetLibraryFullPath This function provides a full path string to the IDEA library.
GetMaxLength Delivers the length of the longest entry in a given field.
GetMaxValue Delivers the maximum value of a numeric, date or time field.
GetMinValue Delivers the minimum value of a numeric, date or time field.
GetRidOf Deletes a file permanently.
HTMLEncode This method converts a string to an HTML-encoded string.
IDEAVersion Returns the IDEA version as string provided by the IDEA code.
ListSeparator Gets the list separator of the system.
MinMaxValue Calculates the min. and max. value of a field.
MonthSymbol Gets the default IDEA month symbol.
RemoveActionField Removes the action field for an IDEA field.
RemoveActionFieldAT Removes the action field for an IDEA field at a given position.
RenameField Renames an IDEA field.
RenameFieldAt Renames an IDEA field at a given position.
RenField Renames an IDEA field and returns the actual new name of the renamed field (as a string).
RenFieldAt Renames an IDEA field at a given position and returns the actual new name of the renamed field (as a string).
Replace Replaces a part of string with a given expression.
ReplaceByListSep Replaces a given string with the system's list separator.
SetFilePeriod Sets a file's period global parameter.
SetFolderPeriod Sets a folder's period global parameter.
ShortDateFormat Gets the short date pattern of the system.
ShortTimeFormat Gets the short time pattern of the system.
SmartAnalyzerVersion Returns the SmartAnalyzer version as a string with 4 elements.
Split Use this function in case of multiple inputs for one global variable.
Str2Dbl This function takes a numeric string value and converts it into a double value.
StringList2Array This function takes string lists as input parameters and returns it as an array.
TagExists Searches for a tag inside an IDEA database,
TryCompareVersions Compares two versions.
UniqueFileFlatName Creates a unique name for a database depending on a specific result file type. The primary input file's folder is not taken into account.
UniqueFileName Creates a unique name for a file, based on a specific type.
YearSymbol Gets the default IDEA year symbol.