Functions

You can call functions in expressions by entering the function name followed by the parameters enclosed in parenthesis '()'. If there are no parameters to the function you must still include the parenthesis. String parameters must be enclosed in either single or double quotes. Numeric parameters should not be enclosed in quotes. True/False parameters may be entered as true or false without quotes or as 0 or 1 (0=false). Function names are not case sensitive, so, gotolastrecord() is the same as GotoLastRecord().

To call a function in an event on a form, or control, precede the function call with an equal '=' sign. For example, if you want to close the active window when the user clicks a button, enter =CloseActiveWindow() in the On push attribute.

If you want to call more than one function, you can connect the functions with operators like the plus '+' sign. For example, if you want to close the active window and open the 'Customer' form when the user clicks a button, enter =CloseActiveWindow() + Open( 'form', 'Customer' ) in the On push attribute.

Alphabetic Function Index

The following table lists all the functions in alphabetical order.

Function	What it does...
abs	Get the absolute value of the given number. If the number is null, a DataNumber with the value null is returned. If the number is blank, 0 is returned.
addDataSource	Add a new data source to the system configuration.
addMultipleRows	Add multiple rows to an open form based on a list or combo box
addRow	Insert a row in a table for a given list of sites that do not already have the row.
addSystemEventListener	Add the listener in the given class to the list of system event listeners.
addThisSiteToCentral	Call the central web service to add this remote site to the central database.
applyEffectiveMasterDataTrans	Queries the audit table for committed transactions on master data tables whose effective date has arrived and calls the appropriate master data change listener for each transaction then changes the status of the transaction to Successful.
ascii	Converts the first character of a string to an ASCII value
asciiToChar	Converts an ASCII code to a character
attachMasterTables	Attach tables from an existing database so it can be edited
attachRemoteTable	Attach a table from an existing database so it can be edited
attachTable	Attach tables from an existing database so it can be edited
callEvaluateExpressionWebMethod	Call the EvaluateExpression web method.
cancelEvent	Cancels current event on the active form.
changePackageStatus	Change status of the transactions for sites in a package to a new status.
changePassword	Change the current user's password.
clearSessionPackage	Remove the selected session package on the client to users have to select a package when making changes.
close	Closes the specified open object window (form view, design view, or print preview).
closeActiveWindow	Closes the active window.
commitTransactions	Commit packages of transactions so they are sent to selected locations
configureApplicationVersions	Configure known versions of application data sources.
copy	Copies an object to the clipboard.
copyAndRefreshSiteData	Copy data for selected tables from one site to other sites and refresh the tables at the other sites on the effective date.
copyCompany	Create a new company by copying the configuration of an existing company.
copyConfigurationVersionData	Copy the data from one configuration version to another version of the same configuration overwriting any existing data.
copyFoodCostPeriodData	Copy food cost data from one period to another.
copyLocationData	Copy site data for a list of tables to other sites. DEPRECATED Use copySiteData instead.
copySelectedObject	Copies the application objected selected on the main menu to the clipboard.
copySiteData	Copy data for selected tables from one location to another location
copySiteSubscriptions	Copy the configuration version subscriptions from one site to other sites leaving the version ID null. If the source site has no subscriptions or the list of configuration ID's to copy is empty, do nothing.
copyVersionData	Copy the data from one version to another version for all configurations overwriting any existing data.
createConfigurationVersionDataSite	Creates a data site to hold version data for configuration version. The ID of the new site will be an unused, negative site number. The name of the site will be the name of the configuration plus a hyphen plus the name of the version. Each table in the configuration type will be added to the list of managed site tables. If there is a previous version of the configuration then the data from the previous version will be copied to the new version.
createConfigurationVersionsCmd	Create configuration versions for the given configuration type and configuration.
createRemoteInstaller	Create an installation program that can be downloaded and used to install EDM at a remote site with pre-configured settings for the current company.
createTransactionTriggers	Create SQL scripts so triggers on application tables at remote sites can generate EDM transactions.
cut	Cuts an object to the clipboard.
cutSelectedObject	Cuts the application objected selected on the main menu to the clipboard.
date	Get current date.
dateToNumber	Converts a date to a number
dateToString	Converts a date to a character string
dateToTimestamp	Converts a date to a timestamp
day	Returns the day value of a date
delete	Deletes an object.
deleteConfiguration	Delete a configuration with the given configuration type and configuration. Deletes are cascaded to all associated Configuration Versions and DataSites.
deleteDataSource	Delete the data source with the given name from the list of data sources for this company.
deleteFoodCostPeriodData	Delete food cost data for one period in a fiscal year.
deleteLocationData	Delete all data from selected tables at selected locations.
deleteOrphanedRecords	Delete menus, attachments, prices, and category links that refer to non-existent items.
deleteRecord	Deletes the selected records (or the current record if none selected) on the active form.
deleteRow	Delete a row or rows from a table for a given list of sites that match the given columns and values in the table with the given name.
deleteSelectedObject	Deletes the application objected selected on the main menu.
deleteTable	Deletes a table.
deleteTableList	Delete a table list.
deleteTransactionFilesFromAmazon	Delete transaction files (*.xml and *.fil) from the Amazon Simple Storage Service (S3).
deployMasterChanges	Deploy master data to application tables in the table map.
design	Opens an object in design view.
designForm	Opens a form in design view.
designNew	Opens a new object in design view.
disableControls	Disable the controls with the given names on the active form.
disableFormControls	Disable the controls with the given names on the given form.
displayHelp	Display help for the specified topic.
dumpEmmaCoverageData	Dump Emma coverage data into the specified file
dumpProfile	Disable profiling and write profile report to log.
editCommitListeners	Edit list of email addresses to be notified when packages are committed.
editConfigurationSubscriptions	Edit Configuration Subscriptions.
editConfigurationTypes	Edit Configuration Types.
editConfigurationVersions	Edit Configuration Versions.
editEmailList	Edit a named list of email addresses.
editFileSharing	View and modify table sharing among locations.
editIrisConfig	Edit IRIS configuration.
editIrisConfigGroups	Edit IRIS config groups.
editIrisItemMenus	Edit IRIS item menus and buttons.
editIrisMenus	Edit IRIS menus and buttons.
editIrisTaxRules	Edit IRIS tax rules.
EditMobileCategoryItemSequence	Edit Mobile Category Item Display Sequence.
EditMobileCategorySequence	Edit Mobile Category Display Sequence.
EditMobileModifierSequence	Edit Mobile Modifier Display Sequence.
editRoles	View and modify roles to which system users may be assigned.
editScheduledTasks	Open form to edit tasks scheduled on the server.
editServerTextFile	Edit a text file on the server.
editSharedTableGroups	Edit groups of tables that are shared together.
editSharing	View and modify table sharing among locations.
editUsers	View and modify system users.
editVersions	Edit Versions.
editVersionSubscriptions	Edit Version Subscriptions.
enableControls	Enable the controls with the given names on the active form.
enableFormControls	Enable the controls with the given names on the given form.
enableProfile	Enable profiling.
encryptAmazonCredentials	Encrypt a property file containing Amazon Web Services (AWS) credentials.
evaluateExpressionAtRemoteSites	Send an expression to a list of remote sites which will evaluate the expression on the server. Only server-side functions may be included in the expression.
executeDirectSQL	Directly execute the given SQL statement on the given data source and return the results in a DataSet. If query is not a select statement, execute the SQL statement and return empty DataSet. Use caution to avoid exceeding available memory.
exit	Exits from the program.
exportData	Exports data from a table or query to a text file.
exportFoodCostFiles	Create ascii export files for CKE food cost system
exportSecurityPolicyToXml	Export users, roles, and other security settings to XML file.
exportSelectedDataToFile	Exports data from a table or query to a text file. Can be run unattended.
extractTestDatabaseChanges	Extract changes to a test database to transaction files
findNextRecord	Finds next record on the current form or spreadsheet using current search options.
findRecord	Finds record on the current form or spreadsheet.
generateFunctionHelp	Generate HTML help file for a list of PluginLoader classes.
generateSnapshot	Generate snapshot of data in snapshot tables
generateTestDatabase	Generate a test database with data from selected locations
getAppObject	Returns application object with specified type and name or null if not found.
getBackgroundProcessViewer	See a window of processes that are running.
getClientPropertyBoolean	Gets a client property associated with the given property name.
getClientPropertyInteger	Gets a client property associated with the given property name.
getClientPropertyString	Gets a client property associated with the given property name.
getCompanyName	Returns the name of the currently selected company.
getConfigProperty	Get configuration property value.
getConfigPropertyWithDefault	Get configuration property value.
getControlValueRow	Create row with column values from the given list of controls on the active form.
getCurrentUserId	Return the ID of the user that is currently logged in or \"\" if no user is logged in.
getEffectiveDate	Get date/time transactions becomes effective for the active form.
getEstimatedRowCount	Get estimated number of rows in the data source of the given form. Will use active form is no form name given.
getForceProcessing	Get flag for whether transactions for the active form should be processed when only processing forced transactions.
getFormNamedControlValues	Get a string containing the names and values of a list of controls from a form. Example: "name1","value1","name2","value2",...
getFormValue	Gets the value of the given control on the given form.
getIniValue	Returns value for the given key from the given ini file or null if not found.
getLastDeploymentInfo	Get the last deployment date and user name with the given deployment type.
getLastVersionChangeInfo	Get the last change date and user name with the given version.
getMasterTableConfigurationType	Gets the Configuration Type for the given table with the given name.
getNamedControlValues	Get a string containing the names and values of a list of controls from the active form. Example: "name1","value1","name2","value2",...
getNextUnusedId	Gets the next unused ID for the given table and column, optionally within a range.
getNumberOfAssignedSites	Get the number of sites assigned to the given version.
getNumberOfUnassignedSites	Get the number of sites that are not assigned to the given version.
getPackageDescription	Get description of package that contains transaction for the active form.
getPackageName	Get name of package that contains transaction for the active form.
getPropertyFileValue	Get the value of a property in a property file.
getSchemaVersions	Returns a list of known application database schemas supported by the system.
getSelectedSites	Get the selected sites for the active form.
getServerCallsPerSecond	Returns the average number of calls per second that can be made to the server after sending as many calls to the server as possible for 5 seconds.
getServerFile	Return the bytes of a file from the server.
getServerFileList	Gets a list of files in the specified directory on the server.
getServerTime	Returns the current system time on the server in milliseconds since 1/1/1970 UTC.
getSessionPackageName	Returns the name of the currently selected package.
getSessionPackageVersionID	Returns the ID of the currently selected package's version or null if there is no selected package or if the selected package doesn't have a version.
getSessionPackageVersionName	Returns the name of the currently selected package's version or null if there is no selected package or if the selected package doesn't have a version.
getSessions	Returns a list of the current active sessions on the server.
getSystemProperty	Get the value of a property in the system.properties file.
getTableAndQueryList	Get a sorted list of tables and queries in this application separated by semicolons.
getTableList	Get a sorted list of tables in this application separated by semicolons.
getTerminationDate	Get date/time transactions terminate for the active form.
getText	Returns the text from the given control.
getTransactionViewer	See a dialog of recent file transactions that are either in yellow or red status.
getUnupdatableSites	Return comma-delimited list of unupdatable sites for the active form.
getUpdatableSites	Return comma-delimited list of updatable sites for the active form.
getUserInput	Prompts user to enter a value.
getValue	Gets data for the specified identifier.
getValueListOfUsersWithRole	Get a value list of users with a given role separated by semicolons.
getVersion	Return the current version of EDM
gotoControl	Moves cursor to a control.
gotoFirstRecord	Moves cursor to the first record on the active form.
gotoFormControl	Moves cursor to a control.
gotoLastRecord	Moves cursor to the last record on the active form.
gotoNewRecord	Moves cursor to the new empty record on the active form.
gotoNextRecord	Moves cursor to the next record on the active form.
gotoPrevRecord	Moves cursor to the previous record on the active form.
gotoRecord	Moves cursor to a specific record on the active form.
greatest	Returns the greater of two numbers
hasPermission	Returns true if the current user has the given permission type for the given object type and name.
iif	Returns one of two values bases on expression
importData	Imports a text file to a table.
importFoodCostProducts	Import ascii file containing products for the food cost system.
importSitesInFileList	Import sites listed in given siteIdFile from given company.
importTableRelations	Import table relations from a text file
importTransactionsFromFile	Import transactions from a CSV file.
insertTableList	Insert a new table list.
isFormValueSelected	Gets whether or not a checkbox, radio button, or toggle button control is currently selected on a form with the given name.
isOnNewRow	True if the currently active form is on a new row, else False.
isValueSelected	Gets whether or not a checkbox, radio button, or toggle button control is currently selected.
least	Returns the lesser of two numbers
left	Returns the leftmost characters of a string
len	Gets the length of a string
loadAllTableData	Load data for the specified location from all tables in the table list
loadCentralData	Load schema for a central database table
loadCentralSchema	Load schema for a central database table
loadPicture	Loads a GIF, JPEG, or PNG image from the specified file
login	Log a user into the system.
logout	Logs the current user out of the system.
lower	Changes each letter of a string to lower case
maximizeContentArea	Maximizes the content area in the main EDM window.
mod	Divides two values and returns the remainder
month	Returns the month value of a date
moveTransactions	Moves transactions for the specified locations from the local send directory to the specified directory.
msg	Displays a message box.
notifyClients	Send a notification to connected clients.
nullValue	Return a null value which can be used in other functions. If you want to set the value of a form control to null, use setFormValueToNull() or setValueToNull().
numberToDate	Converts a number to a date
numberToInt	Returns the integer part of a number string.
numberToString	Converts a number to a string
numberToTime	Converts a number to a time
numberToTimestamp	Converts a number to a timestamp
open	Opens an object.
openForm	Ask server to open a form. All parameters must be complete, user will be prompted for routing information if necessary.
openRowSetForm	Open form to edit row sets to restrict which table rows and columns users may edit.
openSitePropertyValueEditor	Open the Site Property Values form.
partitionTable	Partition a table and set a new partition expression and reorganize the rows into the correct partitions.
paste	Pastes an object from the clipboard.
playbackTestScript	Play a test script back.
pow	Raises a number to a power
processForcedTransactions	Receive and apply pending transactions whose effective date has arrived and whose Force flag is true for all sites.
processTransactions	Receive and apply pending transactions from selected locations whose effective date has arrived
promptForTransactionReport	Display dialog for users to set filters and run transaction report.
publishMasterDataTableList	Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Data is published for each site in share groups using the site’s real ID.
publishMasterDataTables	Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Data is published for each site in share groups using the site’s real ID.
publishXCEDataTableList	Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Share groups are included in the published data with the associated data site IDs.
publishXCEDataTables	Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Share groups are included in the published data with the associated data site IDs.
queryAvg	Gets the average of the values of a column in a table or query using a where clause.
queryCount	Gets the count of the values of a column in a table or query using a where clause.
queryFirst	Gets the first value of a column in a table or query using a where clause.
queryLast	Gets the last value of a column in a table or query using a where clause.
queryMax	Gets the maximum value of a column in a table or query using a where clause.
queryMin	Gets the minimum value of a column in a table or query using a where clause.
querySum	Gets the sum of the values of a column in a table or query using a where clause.
queryValue	Directly execute an SQL statement and return the value of the first column in the first row. If query is not a select statement, execute the SQL statement and return a blank string. Use caution to avoid exceeding available memory.
random	Returns a random number between 0 and the passed number
receiveSiteFilesViaWeb	Receive transaction files over HTTP web connection.
receiveTransactionFilesFromAmazon	Receive transaction files from Amazon Simple Storage Service (S3).
receiveTransactionFilesFromJMS	Receive files from the configured JMS queue into the local incoming folder.
reloadCachedData	Reload cached data such as configuration, site list, etc.
rename	Renames an object to a new name.
replaceAll	Replaces each substring of this string that matches the given regular expression with the given replacement.
replaceTransWithRefresh	Replaces transaction files for the selected locations with a refresh table transaction using the specified snapshot.
requery	Requeries the records on the active form.
requeryControl	Requeries the records of the control's source on the active form.
requestDatedTableRefresh	Send request to location to send table data to replace existing data
requestFile	Copy a file to other locations
requestTableRefresh	Send request to location to send table data to replace existing data
resetSite	Deprecated - use resetSites instead. Send Reset transaction to reset a site to its newly installed state.
resetSites	Send transactions to reset remote sites to their newly installed state and commit the transactions.
restoreContentArea	Restores the content area in the main EDM window.
restoreTestCheckpoint	Disconnect all database connections, restore checkpoint 1, and re-initialize server
retryTest	Retry a test that failed during runTest.
right	Returns the rightmost characters of a string
round	Rounds a number at the specified number of digits past the decimal
runApp	Runs an application as if from the command line. For example, to open the config.xml file in notepad when transactions are processed, set the filespec to c:\windows\system32\notepad.exe, the arguments to c:\edmweb\config.xml, and the wait flag to false. To run a batch file you could set the filespec to cmd and the arguments to /c c:\edmweb\go.bat and the wait flag to false.
runJUnitTest	Run the JUnit tests in the given class.
runPriceChangeByPriceGroupReport	Run price change by price group report with user-specified filters and sorting.
runPriceChangeByPriceReport	Run price change by price report with user-specified filters and sorting.
runPriceChangeReport	Run price report with user-specified filters and sorting.
runReport	Run a report.
runSQL	Runs an SQL statement.
runTaxChangeReport	Run tax change report with user-specified filters and sorting.
runTest	Invoke each method whose name starts with 'test' in the given test class.
runTestMethod	Invoke the given test method.
runTestMethodDirect	Invoke the given test method.
runTestMethods	Invoke the given test method and all methods that follow it in the given class.
runTestUI	Invoke each method whose name starts with 'test' in the given test class.
saveRecord	Saves changes to the current record on the active form.
scheduleVersionAssignments	Schedules a version of site subscriptions. Only sites having the Site Property Name and Value will be schedulable.
select	Selects either an open object or an object in the application window.
selectAllRecords	Selects all records on the active form.
selectLocation	Select one remote location from the list of remote locations maintained in a central database.
selectLocations	Prompt user to select locations from a location tree.
selectLocationsAndPackage	Prompt user to select locations from a location tree and a package for transactions.
selectPackage	Prompt user to select from a list of transaction packages or create a new one.
selectRecord	Selects current record on the active form.
selectSessionPackage	Specify the package to use for all changes until a different session package is selected.
sendAddSchemasTransaction	Send an transaction to update the table list and schema at selected sites.
sendDatedTableRefresh	Send table data to locations to replace existing data
sendDeleteFileTransaction	Send transaction to delete a file.
sendEvaluateTransaction	Send a transaction to cause the receiver to evaluate an expression.
sendExecuteTransaction	Send transaction to execute an operation system command at selected sites.
sendFile	Send a file to other locations
sendGetSchemasTransaction	Send a transaction to get the table list and schema from selected sites.
sendRefreshToTestSite	Send table refresh transaction from a site to a lab/test site.
sendRemoteFiles	Send files listed in remote files table to sites.
sendRenameFileTransaction	Send transaction to rename a file.
sendSiteFilesViaWeb	Send transaction files over HTTP web connection.
sendSynchronizeDirectoryTransaction	Send a transaction to synchronize a local directory with a directory at other sites.
sendTableRefresh	Send table data to locations to replace existing data
sendTransactionFilesToAmazon	Send transaction files to Amazon Simple Storage Service (S3).
sendTransactionFilesToJMS	Send outgoing files for the given sites to a JMS queue.
setClientPropertyBoolean	Sets a client property value with the given name.
setClientPropertyInteger	Sets a client property value with the given name.
setClientPropertyString	Sets a client property value with the given name.
setConfigProperty	Set configuration property value.
setControlProperty	Sets a property value for a control on the active form.
setFormControlProperty	Sets a property value for a control on a form.
setFormRowSource	Sets the row source value for a control on the active form.
setFormSiteValue	Sets site specific data for a control on the specified form.
setFormSiteValueToNull	Sets site specific data for a control on the specified form to null.
setFormValue	Sets data for a control on a form.
setFormValueToNull	Sets data for controls on a form to null.
setLastReceivedTranFileNumberToIncoming	Set the last received transaction file number for a site to the lowest transaction file number in the incoming directory - 1.
setLogConsoleLevel	Sets level of log messages written to console.
setLogFileLevel	Sets level of log messages written to log file.
setPropertyFileValue	Set the value of a property in a property file.
setRecordModified	Sets the current record as modified so that it will be saved.
setRowSource	Sets the row source value for a control on the active form.
setSiteValue	Sets site specific data for a control on the active form.
setSiteValueToNull	Sets site specific data for a control on the active form to null.
setValue	Sets data for a control on the active form.
setValueToNull	Sets data for a control on the active form to null.
shareLocationData	Share data for selected tables from one location to another location
showAboutDialog	Displays the About dialog with system name and copyright info.
showCopySiteSubscriptionsForm	Show the UI for selecting a source site, target sites, and configurations.
showCreateSiteSubscriptionsForm	Show the UI for creating site subscriptions.
showDocument	Display a document in a browser window. Applets can only display documents on the same server they were started from.
showErrors	Turn error messages on or off
showLdapPropertyForm	Displays the LDAP configuration form.
showSiteManager	Display site manager window.
showWarnings	Turn warning messages on or off
sleep	Causes thread to sleep for the specified number of milliseconds.
space	Creates a string of blanks
startRecordingTestScript	Tell server to start recording test script with the next login command.
stopRecordingTestScript	Tell server to stop recording test script.
stringToDate	Converts a date string to a date value
stringToInt	Converts a string to an integer.
stringToNumber	Converts a string to a number
stringToTime	Converts a time string to a time value
stringToTimestamp	Converts a timestamp string to a timestamp value
substring	Returns characters from the middle of a string
synchronizeSitePropertyValues	Imort and sync the site property values from an outside data source
time	Gets current time of day
timestamp	Get current date and time.
timestampToDate	Converts a timestamp to a date
timestampToNumber	Converts a timestamp to a number
timestampToString	Converts a timestamp to a character string
timestampToTime	Converts a timestamp to a time
timeToNumber	Converts a time to a number
timeToString	Converts a time to a character string
timeToTimestamp	Converts a time to a timestamp
transferLocationFilesViaFTP	Transfer files over FTP connection.
transferLocationFilesViaRAS	Transfer files over network connection.
transferLocationFilesViaWeb	Transfer files over HTTP web connection.
transferSiteFilesViaFTP	Transfer transaction files over FTP connection.
transferSiteFilesViaRAS	Transfer transaction files over network connection.
transferSiteFilesViaWeb	Transfer transaction files over HTTP web connection.
trim	Trims the blanks from both ends of a string
trimLeft	Trims the blanks from the left end of a string
trimRight	Trims the blanks from the right end of a string
undo	Performs undo operation in the active window.
unlockAppObjects	Prompt user to unlock selected application objects that are locked while there design is being edited.
unshareLocationData	Stop sharing data for selected tables from one location to another location
updateAmazonDirToMatchLocalDir	Update an Amazon S3 directory to match a local directory.
updateLocalDirToMatchAmazonDir	Update a local directory to match a directory on Amazon S3.
updateLocalDirToMatchWebDir	Update a local directory to match a directory on the EDM web server.
updateRows	Update selected rows for selected sites and generate transactions for the changes.
updateTableList	Update a table list.
updateTransferSettings	Save the given transfer host, user ID, password, and company name used to connect to a central EDM server
updateWebDirToMatchLocalDir	Update an directory on the EDM web server to match a local directory.
upper	Changes each letter of a string to upper case
validateTableList	Validate references between tables
validateTables	Validate references between tables
view	Opens an Table, Query, or Form on the client.
viewForm	Ask server to open a form on the client that is visible in its default view. All parameters must be complete, user will be prompted for routing information if necessary.
waitForServerJobs	Wait for all server jobs to complete. If not server jobs are running when the method is called, wait up to one second for server jobs to start. After waiting for a server job to finish, wait up to one second for another server job to start. Total minimum wait time is two seconds.
year	Returns the year value of a date

String Functions

Function	What it does...
ascii	Converts the first character of a string to an ASCII value
asciiToChar	Converts an ASCII code to a character
getVersion	Return the current version of EDM
left	Returns the leftmost characters of a string
len	Gets the length of a string
lower	Changes each letter of a string to lower case
replaceAll	Replaces each substring of this string that matches the given regular expression with the given replacement.
right	Returns the rightmost characters of a string
space	Creates a string of blanks
substring	Returns characters from the middle of a string
trim	Trims the blanks from both ends of a string
trimLeft	Trims the blanks from the left end of a string
trimRight	Trims the blanks from the right end of a string
upper	Changes each letter of a string to upper case

Numeric Functions

Function	What it does...
abs	Get the absolute value of the given number. If the number is null, a DataNumber with the value null is returned. If the number is blank, 0 is returned.
greatest	Returns the greater of two numbers
least	Returns the lesser of two numbers
mod	Divides two values and returns the remainder
pow	Raises a number to a power
random	Returns a random number between 0 and the passed number
round	Rounds a number at the specified number of digits past the decimal

Date Functions

Function	What it does...
date	Get current date.
day	Returns the day value of a date
month	Returns the month value of a date
time	Gets current time of day
timestamp	Get current date and time.
year	Returns the year value of a date

Conversion Functions

Function	What it does...
dateToNumber	Converts a date to a number
dateToString	Converts a date to a character string
dateToTimestamp	Converts a date to a timestamp
numberToDate	Converts a number to a date
numberToInt	Returns the integer part of a number string.
numberToString	Converts a number to a string
numberToTime	Converts a number to a time
numberToTimestamp	Converts a number to a timestamp
stringToDate	Converts a date string to a date value
stringToInt	Converts a string to an integer.
stringToNumber	Converts a string to a number
stringToTime	Converts a time string to a time value
stringToTimestamp	Converts a timestamp string to a timestamp value
timestampToDate	Converts a timestamp to a date
timestampToNumber	Converts a timestamp to a number
timestampToString	Converts a timestamp to a character string
timestampToTime	Converts a timestamp to a time
timeToNumber	Converts a time to a number
timeToString	Converts a time to a character string
timeToTimestamp	Converts a time to a timestamp

Object Functions

Function	What it does...
close	Closes the specified open object window (form view, design view, or print preview).
closeActiveWindow	Closes the active window.
copy	Copies an object to the clipboard.
copySelectedObject	Copies the application objected selected on the main menu to the clipboard.
cut	Cuts an object to the clipboard.
cutSelectedObject	Cuts the application objected selected on the main menu to the clipboard.
delete	Deletes an object.
deleteSelectedObject	Deletes the application objected selected on the main menu.
deleteTable	Deletes a table.
design	Opens an object in design view.
designForm	Opens a form in design view.
designNew	Opens a new object in design view.
getAppObject	Returns application object with specified type and name or null if not found.
open	Opens an object.
paste	Pastes an object from the clipboard.
rename	Renames an object to a new name.
select	Selects either an open object or an object in the application window.
unlockAppObjects	Prompt user to unlock selected application objects that are locked while there design is being edited.
view	Opens an Table, Query, or Form on the client.

Record Functions

Function	What it does...
deleteRecord	Deletes the selected records (or the current record if none selected) on the active form.
findNextRecord	Finds next record on the current form or spreadsheet using current search options.
findRecord	Finds record on the current form or spreadsheet.
gotoFirstRecord	Moves cursor to the first record on the active form.
gotoLastRecord	Moves cursor to the last record on the active form.
gotoNewRecord	Moves cursor to the new empty record on the active form.
gotoNextRecord	Moves cursor to the next record on the active form.
gotoPrevRecord	Moves cursor to the previous record on the active form.
gotoRecord	Moves cursor to a specific record on the active form.
saveRecord	Saves changes to the current record on the active form.
selectAllRecords	Selects all records on the active form.
selectRecord	Selects current record on the active form.

Form Functions

Function	What it does...
addMultipleRows	Add multiple rows to an open form based on a list or combo box
cancelEvent	Cancels current event on the active form.
deleteOrphanedRecords	Delete menus, attachments, prices, and category links that refer to non-existent items.
editIrisConfig	Edit IRIS configuration.
editIrisConfigGroups	Edit IRIS config groups.
editIrisItemMenus	Edit IRIS item menus and buttons.
editIrisMenus	Edit IRIS menus and buttons.
editIrisTaxRules	Edit IRIS tax rules.
getClientPropertyBoolean	Gets a client property associated with the given property name.
getClientPropertyInteger	Gets a client property associated with the given property name.
getClientPropertyString	Gets a client property associated with the given property name.
getEstimatedRowCount	Get estimated number of rows in the data source of the given form. Will use active form is no form name given.
getFormNamedControlValues	Get a string containing the names and values of a list of controls from a form. Example: "name1","value1","name2","value2",...
getFormValue	Gets the value of the given control on the given form.
getNamedControlValues	Get a string containing the names and values of a list of controls from the active form. Example: "name1","value1","name2","value2",...
getText	Returns the text from the given control.
getValue	Gets data for the specified identifier.
gotoControl	Moves cursor to a control.
gotoFormControl	Moves cursor to a control.
isFormValueSelected	Gets whether or not a checkbox, radio button, or toggle button control is currently selected on a form with the given name.
isValueSelected	Gets whether or not a checkbox, radio button, or toggle button control is currently selected.
requery	Requeries the records on the active form.
requeryControl	Requeries the records of the control's source on the active form.
runPriceChangeByPriceGroupReport	Run price change by price group report with user-specified filters and sorting.
runPriceChangeByPriceReport	Run price change by price report with user-specified filters and sorting.
runPriceChangeReport	Run price report with user-specified filters and sorting.
runTaxChangeReport	Run tax change report with user-specified filters and sorting.
setClientPropertyBoolean	Sets a client property value with the given name.
setClientPropertyInteger	Sets a client property value with the given name.
setClientPropertyString	Sets a client property value with the given name.
setControlProperty	Sets a property value for a control on the active form.
setFormControlProperty	Sets a property value for a control on a form.
setFormRowSource	Sets the row source value for a control on the active form.
setFormSiteValue	Sets site specific data for a control on the specified form.
setFormSiteValueToNull	Sets site specific data for a control on the specified form to null.
setFormValue	Sets data for a control on a form.
setFormValueToNull	Sets data for controls on a form to null.
setRecordModified	Sets the current record as modified so that it will be saved.
setRowSource	Sets the row source value for a control on the active form.
setSiteValue	Sets site specific data for a control on the active form.
setSiteValueToNull	Sets site specific data for a control on the active form to null.
setValue	Sets data for a control on the active form.
setValueToNull	Sets data for a control on the active form to null.
undo	Performs undo operation in the active window.

Lookup Functions

Function	What it does...
queryAvg	Gets the average of the values of a column in a table or query using a where clause.
queryCount	Gets the count of the values of a column in a table or query using a where clause.
queryFirst	Gets the first value of a column in a table or query using a where clause.
queryLast	Gets the last value of a column in a table or query using a where clause.
queryMax	Gets the maximum value of a column in a table or query using a where clause.
queryMin	Gets the minimum value of a column in a table or query using a where clause.
querySum	Gets the sum of the values of a column in a table or query using a where clause.

System Functions

Function	What it does...
addRow	Insert a row in a table for a given list of sites that do not already have the row.
addSystemEventListener	Add the listener in the given class to the list of system event listeners.
addThisSiteToCentral	Call the central web service to add this remote site to the central database.
attachMasterTables	Attach tables from an existing database so it can be edited
attachTable	Attach tables from an existing database so it can be edited
callEvaluateExpressionWebMethod	Call the EvaluateExpression web method.
createTransactionTriggers	Create SQL scripts so triggers on application tables at remote sites can generate EDM transactions.
deleteRow	Delete a row or rows from a table for a given list of sites that match the given columns and values in the table with the given name.
deleteTableList	Delete a table list.
displayHelp	Display help for the specified topic.
dumpEmmaCoverageData	Dump Emma coverage data into the specified file
dumpProfile	Disable profiling and write profile report to log.
editEmailList	Edit a named list of email addresses.
enableProfile	Enable profiling.
evaluateExpressionAtRemoteSites	Send an expression to a list of remote sites which will evaluate the expression on the server. Only server-side functions may be included in the expression.
executeDirectSQL	Directly execute the given SQL statement on the given data source and return the results in a DataSet. If query is not a select statement, execute the SQL statement and return empty DataSet. Use caution to avoid exceeding available memory.
exit	Exits from the program.
exportData	Exports data from a table or query to a text file.
exportSecurityPolicyToXml	Export users, roles, and other security settings to XML file.
getBackgroundProcessViewer	See a window of processes that are running.
getCurrentUserId	Return the ID of the user that is currently logged in or \"\" if no user is logged in.
getIniValue	Returns value for the given key from the given ini file or null if not found.
getServerCallsPerSecond	Returns the average number of calls per second that can be made to the server after sending as many calls to the server as possible for 5 seconds.
getServerFile	Return the bytes of a file from the server.
getServerFileList	Gets a list of files in the specified directory on the server.
getServerTime	Returns the current system time on the server in milliseconds since 1/1/1970 UTC.
getSessions	Returns a list of the current active sessions on the server.
getSystemProperty	Get the value of a property in the system.properties file.
getTableAndQueryList	Get a sorted list of tables and queries in this application separated by semicolons.
getTableList	Get a sorted list of tables in this application separated by semicolons.
getTransactionViewer	See a dialog of recent file transactions that are either in yellow or red status.
getUserInput	Prompts user to enter a value.
hasPermission	Returns true if the current user has the given permission type for the given object type and name.
iif	Returns one of two values bases on expression
importData	Imports a text file to a table.
importTransactionsFromFile	Import transactions from a CSV file.
insertTableList	Insert a new table list.
loadPicture	Loads a GIF, JPEG, or PNG image from the specified file
login	Log a user into the system.
logout	Logs the current user out of the system.
msg	Displays a message box.
openSitePropertyValueEditor	Open the Site Property Values form.
partitionTable	Partition a table and set a new partition expression and reorganize the rows into the correct partitions.
playbackTestScript	Play a test script back.
queryValue	Directly execute an SQL statement and return the value of the first column in the first row. If query is not a select statement, execute the SQL statement and return a blank string. Use caution to avoid exceeding available memory.
retryTest	Retry a test that failed during runTest.
runApp	Runs an application as if from the command line. For example, to open the config.xml file in notepad when transactions are processed, set the filespec to c:\windows\system32\notepad.exe, the arguments to c:\edmweb\config.xml, and the wait flag to false. To run a batch file you could set the filespec to cmd and the arguments to /c c:\edmweb\go.bat and the wait flag to false.
runJUnitTest	Run the JUnit tests in the given class.
runReport	Run a report.
runSQL	Runs an SQL statement.
runTest	Invoke each method whose name starts with 'test' in the given test class.
runTestMethod	Invoke the given test method.
runTestMethodDirect	Invoke the given test method.
runTestMethods	Invoke the given test method and all methods that follow it in the given class.
runTestUI	Invoke each method whose name starts with 'test' in the given test class.
selectLocation	Select one remote location from the list of remote locations maintained in a central database.
setLogConsoleLevel	Sets level of log messages written to console.
setLogFileLevel	Sets level of log messages written to log file.
showAboutDialog	Displays the About dialog with system name and copyright info.
showDocument	Display a document in a browser window. Applets can only display documents on the same server they were started from.
showErrors	Turn error messages on or off
showLdapPropertyForm	Displays the LDAP configuration form.
showWarnings	Turn warning messages on or off
sleep	Causes thread to sleep for the specified number of milliseconds.
startRecordingTestScript	Tell server to start recording test script with the next login command.
stopRecordingTestScript	Tell server to stop recording test script.
updateTableList	Update a table list.
waitForServerJobs	Wait for all server jobs to complete. If not server jobs are running when the method is called, wait up to one second for server jobs to start. After waiting for a server job to finish, wait up to one second for another server job to start. Total minimum wait time is two seconds.

Enterprise Data Manager Functions

Function	What it does...
addDataSource	Add a new data source to the system configuration.
attachRemoteTable	Attach a table from an existing database so it can be edited
changePackageStatus	Change status of the transactions for sites in a package to a new status.
changePassword	Change the current user's password.
clearSessionPackage	Remove the selected session package on the client to users have to select a package when making changes.
commitTransactions	Commit packages of transactions so they are sent to selected locations
configureApplicationVersions	Configure known versions of application data sources.
copyAndRefreshSiteData	Copy data for selected tables from one site to other sites and refresh the tables at the other sites on the effective date.
copyCompany	Create a new company by copying the configuration of an existing company.
copyFoodCostPeriodData	Copy food cost data from one period to another.
copyLocationData	Copy site data for a list of tables to other sites. DEPRECATED Use copySiteData instead.
copySiteData	Copy data for selected tables from one location to another location
createRemoteInstaller	Create an installation program that can be downloaded and used to install EDM at a remote site with pre-configured settings for the current company.
deleteDataSource	Delete the data source with the given name from the list of data sources for this company.
deleteFoodCostPeriodData	Delete food cost data for one period in a fiscal year.
deleteLocationData	Delete all data from selected tables at selected locations.
deleteTransactionFilesFromAmazon	Delete transaction files (*.xml and *.fil) from the Amazon Simple Storage Service (S3).
disableControls	Disable the controls with the given names on the active form.
disableFormControls	Disable the controls with the given names on the given form.
editCommitListeners	Edit list of email addresses to be notified when packages are committed.
editFileSharing	View and modify table sharing among locations.
EditMobileCategoryItemSequence	Edit Mobile Category Item Display Sequence.
EditMobileCategorySequence	Edit Mobile Category Display Sequence.
EditMobileModifierSequence	Edit Mobile Modifier Display Sequence.
editRoles	View and modify roles to which system users may be assigned.
editScheduledTasks	Open form to edit tasks scheduled on the server.
editServerTextFile	Edit a text file on the server.
editSharedTableGroups	Edit groups of tables that are shared together.
editSharing	View and modify table sharing among locations.
editUsers	View and modify system users.
enableControls	Enable the controls with the given names on the active form.
enableFormControls	Enable the controls with the given names on the given form.
encryptAmazonCredentials	Encrypt a property file containing Amazon Web Services (AWS) credentials.
exportFoodCostFiles	Create ascii export files for CKE food cost system
exportSelectedDataToFile	Exports data from a table or query to a text file. Can be run unattended.
extractTestDatabaseChanges	Extract changes to a test database to transaction files
generateFunctionHelp	Generate HTML help file for a list of PluginLoader classes.
generateSnapshot	Generate snapshot of data in snapshot tables
generateTestDatabase	Generate a test database with data from selected locations
getCompanyName	Returns the name of the currently selected company.
getConfigProperty	Get configuration property value.
getConfigPropertyWithDefault	Get configuration property value.
getControlValueRow	Create row with column values from the given list of controls on the active form.
getEffectiveDate	Get date/time transactions becomes effective for the active form.
getForceProcessing	Get flag for whether transactions for the active form should be processed when only processing forced transactions.
getNextUnusedId	Gets the next unused ID for the given table and column, optionally within a range.
getPackageDescription	Get description of package that contains transaction for the active form.
getPackageName	Get name of package that contains transaction for the active form.
getPropertyFileValue	Get the value of a property in a property file.
getSchemaVersions	Returns a list of known application database schemas supported by the system.
getSelectedSites	Get the selected sites for the active form.
getSessionPackageName	Returns the name of the currently selected package.
getSessionPackageVersionID	Returns the ID of the currently selected package's version or null if there is no selected package or if the selected package doesn't have a version.
getSessionPackageVersionName	Returns the name of the currently selected package's version or null if there is no selected package or if the selected package doesn't have a version.
getTerminationDate	Get date/time transactions terminate for the active form.
getUnupdatableSites	Return comma-delimited list of unupdatable sites for the active form.
getUpdatableSites	Return comma-delimited list of updatable sites for the active form.
getValueListOfUsersWithRole	Get a value list of users with a given role separated by semicolons.
importFoodCostProducts	Import ascii file containing products for the food cost system.
importSitesInFileList	Import sites listed in given siteIdFile from given company.
importTableRelations	Import table relations from a text file
isOnNewRow	True if the currently active form is on a new row, else False.
loadAllTableData	Load data for the specified location from all tables in the table list
loadCentralData	Load schema for a central database table
loadCentralSchema	Load schema for a central database table
maximizeContentArea	Maximizes the content area in the main EDM window.
moveTransactions	Moves transactions for the specified locations from the local send directory to the specified directory.
notifyClients	Send a notification to connected clients.
nullValue	Return a null value which can be used in other functions. If you want to set the value of a form control to null, use setFormValueToNull() or setValueToNull().
openForm	Ask server to open a form. All parameters must be complete, user will be prompted for routing information if necessary.
openRowSetForm	Open form to edit row sets to restrict which table rows and columns users may edit.
processForcedTransactions	Receive and apply pending transactions whose effective date has arrived and whose Force flag is true for all sites.
processTransactions	Receive and apply pending transactions from selected locations whose effective date has arrived
promptForTransactionReport	Display dialog for users to set filters and run transaction report.
receiveSiteFilesViaWeb	Receive transaction files over HTTP web connection.
receiveTransactionFilesFromAmazon	Receive transaction files from Amazon Simple Storage Service (S3).
receiveTransactionFilesFromJMS	Receive files from the configured JMS queue into the local incoming folder.
reloadCachedData	Reload cached data such as configuration, site list, etc.
replaceTransWithRefresh	Replaces transaction files for the selected locations with a refresh table transaction using the specified snapshot.
requestDatedTableRefresh	Send request to location to send table data to replace existing data
requestFile	Copy a file to other locations
requestTableRefresh	Send request to location to send table data to replace existing data
resetSite	Deprecated - use resetSites instead. Send Reset transaction to reset a site to its newly installed state.
resetSites	Send transactions to reset remote sites to their newly installed state and commit the transactions.
restoreContentArea	Restores the content area in the main EDM window.
restoreTestCheckpoint	Disconnect all database connections, restore checkpoint 1, and re-initialize server
selectLocations	Prompt user to select locations from a location tree.
selectLocationsAndPackage	Prompt user to select locations from a location tree and a package for transactions.
selectPackage	Prompt user to select from a list of transaction packages or create a new one.
selectSessionPackage	Specify the package to use for all changes until a different session package is selected.
sendAddSchemasTransaction	Send an transaction to update the table list and schema at selected sites.
sendDatedTableRefresh	Send table data to locations to replace existing data
sendDeleteFileTransaction	Send transaction to delete a file.
sendEvaluateTransaction	Send a transaction to cause the receiver to evaluate an expression.
sendExecuteTransaction	Send transaction to execute an operation system command at selected sites.
sendFile	Send a file to other locations
sendGetSchemasTransaction	Send a transaction to get the table list and schema from selected sites.
sendRefreshToTestSite	Send table refresh transaction from a site to a lab/test site.
sendRemoteFiles	Send files listed in remote files table to sites.
sendRenameFileTransaction	Send transaction to rename a file.
sendSiteFilesViaWeb	Send transaction files over HTTP web connection.
sendSynchronizeDirectoryTransaction	Send a transaction to synchronize a local directory with a directory at other sites.
sendTableRefresh	Send table data to locations to replace existing data
sendTransactionFilesToAmazon	Send transaction files to Amazon Simple Storage Service (S3).
sendTransactionFilesToJMS	Send outgoing files for the given sites to a JMS queue.
setConfigProperty	Set configuration property value.
setLastReceivedTranFileNumberToIncoming	Set the last received transaction file number for a site to the lowest transaction file number in the incoming directory - 1.
setPropertyFileValue	Set the value of a property in a property file.
shareLocationData	Share data for selected tables from one location to another location
showSiteManager	Display site manager window.
synchronizeSitePropertyValues	Imort and sync the site property values from an outside data source
transferLocationFilesViaFTP	Transfer files over FTP connection.
transferLocationFilesViaRAS	Transfer files over network connection.
transferLocationFilesViaWeb	Transfer files over HTTP web connection.
transferSiteFilesViaFTP	Transfer transaction files over FTP connection.
transferSiteFilesViaRAS	Transfer transaction files over network connection.
transferSiteFilesViaWeb	Transfer transaction files over HTTP web connection.
unshareLocationData	Stop sharing data for selected tables from one location to another location
updateAmazonDirToMatchLocalDir	Update an Amazon S3 directory to match a local directory.
updateLocalDirToMatchAmazonDir	Update a local directory to match a directory on Amazon S3.
updateLocalDirToMatchWebDir	Update a local directory to match a directory on the EDM web server.
updateRows	Update selected rows for selected sites and generate transactions for the changes.
updateTransferSettings	Save the given transfer host, user ID, password, and company name used to connect to a central EDM server
updateWebDirToMatchLocalDir	Update an directory on the EDM web server to match a local directory.
validateTableList	Validate references between tables
validateTables	Validate references between tables
viewForm	Ask server to open a form on the client that is visible in its default view. All parameters must be complete, user will be prompted for routing information if necessary.

Master Data Management Functions

Function	What it does...
applyEffectiveMasterDataTrans	Queries the audit table for committed transactions on master data tables whose effective date has arrived and calls the appropriate master data change listener for each transaction then changes the status of the transaction to Successful.
copyConfigurationVersionData	Copy the data from one configuration version to another version of the same configuration overwriting any existing data.
copySiteSubscriptions	Copy the configuration version subscriptions from one site to other sites leaving the version ID null. If the source site has no subscriptions or the list of configuration ID's to copy is empty, do nothing.
copyVersionData	Copy the data from one version to another version for all configurations overwriting any existing data.
createConfigurationVersionDataSite	Creates a data site to hold version data for configuration version. The ID of the new site will be an unused, negative site number. The name of the site will be the name of the configuration plus a hyphen plus the name of the version. Each table in the configuration type will be added to the list of managed site tables. If there is a previous version of the configuration then the data from the previous version will be copied to the new version.
createConfigurationVersionsCmd	Create configuration versions for the given configuration type and configuration.
deleteConfiguration	Delete a configuration with the given configuration type and configuration. Deletes are cascaded to all associated Configuration Versions and DataSites.
deployMasterChanges	Deploy master data to application tables in the table map.
editConfigurationSubscriptions	Edit Configuration Subscriptions.
editConfigurationTypes	Edit Configuration Types.
editConfigurationVersions	Edit Configuration Versions.
editVersions	Edit Versions.
editVersionSubscriptions	Edit Version Subscriptions.
getLastDeploymentInfo	Get the last deployment date and user name with the given deployment type.
getLastVersionChangeInfo	Get the last change date and user name with the given version.
getMasterTableConfigurationType	Gets the Configuration Type for the given table with the given name.
getNumberOfAssignedSites	Get the number of sites assigned to the given version.
getNumberOfUnassignedSites	Get the number of sites that are not assigned to the given version.
publishMasterDataTableList	Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Data is published for each site in share groups using the site’s real ID.
publishMasterDataTables	Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Data is published for each site in share groups using the site’s real ID.
publishXCEDataTableList	Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Share groups are included in the published data with the associated data site IDs.
publishXCEDataTables	Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Share groups are included in the published data with the associated data site IDs.
scheduleVersionAssignments	Schedules a version of site subscriptions. Only sites having the Site Property Name and Value will be schedulable.
showCopySiteSubscriptionsForm	Show the UI for selecting a source site, target sites, and configurations.
showCreateSiteSubscriptionsForm	Show the UI for creating site subscriptions.

abs

Get the absolute value of the given number. If the number is null, a DataNumber with the value null is returned. If the number is blank, 0 is returned.

Syntax:

abs( 'number')

Parameters:

number - Number whose absolute value is to be returned.

Returns:

Absolute value of number

Class:

edmcommon.function.CommonFunctions

addDataSource

Add a new data source to the system configuration.

Syntax:

addDataSource( 'name', 'version', 'type', 'connectionString', 'encryptConnectionString', 'database', 'server', 'trusted', 'user', 'password', 'encryptPassword', 'isSystemDataSource')

Parameters:

name - Data source name used by the system.

version - Application-specific database version number.

type - Data source type, see DbType class.

connectionString - Connection string for data source. If specified, it will be used as-is to connect to the data source. If not specified, it will be built from other attributes. This allows users to customize the connection string as necessary. Care should be taken that the database and server names in the connection string match the database and server name from the other attributes.

encryptConnectionString - 'Y' if connection string should be encrypted when saved.

database - Database name.

server - Server name, may have :PORT or :SID suffixes.

trusted - 'Y' if this is ODBC data source that uses Windows login, else 'N'.

user - User name used to log into data source.

password - Password used to log into data source.

encryptPassword - 'Y' if password should be encrypted when saved.

isSystemDataSource - 'Y' if this is the system data source.

Returns:

Void.

Class:

edmcommon.cmd.AddDataSourceCmd

addMultipleRows

Add multiple rows to an open form based on a list or combo box

Syntax:

addMultipleRows( 'formName', 'controlName')

Parameters:

formName - Name of the form

controlName - Name of the list of combo control

Returns:

Void.

Class:

edmcommon.cmd.AddMultipleRowsFunction

addRow

Insert a row in a table for a given list of sites that do not already have the row.

For example, when entering a product, this function can be called in the AfterInsert event to add a row to the product type table. For example, to add rows to the TNG_dbo_ProductTypes table after the user inserts a row in the TNG_dbo_Products table, set the afterInsert property of the Product form to: "=addRow( 'TNG_dbo_ProductTypes', getNamedControlValues( 'id,name,description' ), getSelectedSites() )"

Syntax:

addRow( 'tableName', 'namedColumnValues', 'siteIdList')

Parameters:

tableName - Name of a table.

namedColumnValues - List of column names and values of the form: "name1","value1","name2","value2"...

siteIdList -

Returns:

Void.

Class:

edmcommon.cmd.AddRowCmd

addSystemEventListener

Add the listener in the given class to the list of system event listeners.

Syntax:

addSystemEventListener( 'listenerClassName')

Parameters:

listenerClassName - Name of listener class.

Returns:

Void.

Class:

edmcommon.cmd.AddSystemEventListenerCmd

addThisSiteToCentral

Call the central web service to add this remote site to the central database.

If the site does not exist in the central database it will be added. If it is the first site in the company, a table list will be requested. If the site data has not been loaded then a table refresh will be requested.

Syntax:

addThisSiteToCentral( 'url', 'userId', 'password')

Parameters:

url - URL of the central server such as http://xpress.xpient.com/edm.

userId - User ID used to log in to central system.

password - Password used to log into central system.

Returns:

Void.

Class:

edmcommon.cmd.AddThisSiteToCentralCmd

applyEffectiveMasterDataTrans

Queries the audit table for committed transactions on master data tables whose effective date has arrived and calls the appropriate master data change listener for each transaction then changes the status of the transaction to Successful.

Syntax:

applyEffectiveMasterDataTrans()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.ApplyEffectiveMasterDataTransCmd

ascii

Converts the first character of a string to an ASCII value

Syntax:

ascii( 'astring')

Parameters:

astring - String whose first character is to be converted

Returns:

ASCII value of the first character of the string

Class:

edmcommon.function.CommonFunctions

asciiToChar

Converts an ASCII code to a character

Syntax:

asciiToChar( asciiCode)

Parameters:

asciiCode - ASCII code to convert

Returns:

Character that is assigned to the ASCII code

Class:

edmcommon.function.CommonFunctions

attachMasterTables

Attach tables from an existing database so it can be edited

Attaches master tables by creating a central table with the CDMLOCID column added to the table and all indexes. Adds a remote table record for the central site with a version of '1'. Adds a remote table record for every remote site with a version of null so transactions are not generated to the site. Adds a remote data source version for the central site of '1'. Adds a remote data source version for every remote site of '0'. Adds the tables to a table list called 'Attached Master Tables'. Adds a data source version 0 to the convert file and a version 1 which adds all the tables to the convert file.

Syntax:

attachMasterTables( 'tableNames', 'dataSourceName')

Parameters:

tableNames - Comma-delimited list of table names to attach (blank means prompt user).

dataSourceName - Name of the data source in the configuration that contains the tables (blank means prompt user).

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.AttachMasterTablesCmd

attachRemoteTable

Attach a table from an existing database so it can be edited

Syntax:

attachRemoteTable( 'tableName', 'dataSourceName', 'tableVersion', 'ignoreInserts', 'ignoreUpdates', 'ignoreDeletes')

Parameters:

tableName - Name of table to be attached (blank to prompt user).

dataSourceName - Name of data source from which to attach the table (blank to prompt user).

tableVersion - Version number of table to be attached (blank to prompt user).

ignoreInserts - True if central database should not accept inserts from remote location (blank to prompt user).

ignoreUpdates - True if central database should not accept updates from remote location (blank to prompt user).

ignoreDeletes - True if central database should not accept deletes from remote location (blank to prompt user).

Returns:

Void.

Class:

edmcommon.cmd.AttachTableCmd

attachTable

Attach tables from an existing database so it can be edited

Syntax:

attachTable( 'tableNames', 'dataSourceName')

Parameters:

tableNames - Comma-separated list of table names to be attached (blank to prompt user).

dataSourceName - Name of data source from which to attach the tables (blank to prompt user).

Returns:

Void.

Class:

edmcommon.cmd.AttachTableCmd

callEvaluateExpressionWebMethod

Call the EvaluateExpression web method.

Syntax:

callEvaluateExpressionWebMethod( 'expression', 'userId', 'encryptedPassword', 'company', 'wsdlUrl')

Parameters:

expression - Expression to evaluate. For example: processTransactions('*')

userId - ID of the user making the call.

encryptedPassword - Encrypted password for the user. Can be found in policy.xml.

company - Name of company where expression is to be evaluated.

wsdlUrl - URL of the WSDL for the web service.

Returns:

Void.

Class:

edmcommon.cmd.CallEvaluateExpressionWebMethodCmd

cancelEvent

Cancels current event on the active form.

Syntax:

cancelEvent()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.CancelEventFunction

changePackageStatus

Change status of the transactions for sites in a package to a new status.

Syntax:

changePackageStatus( 'oldStatus', 'newStatus', 'packageName', 'siteIdList')

Parameters:

oldStatus - Transactions with this status type will have their status changed (Open, Committed, Sent, Received, Successful, Failed, Closed, or blank to prompt user to select).

newStatus - Transactions will be changed to this status type (Open, Committed, Sent, Received, Successful, Failed, Closed, or blank to prompt user to select).

packageName - Name of package containing transactions to change (blank means prompt user to select).

siteIdList - Comma-delimited list of site IDs whose transactions are to be changed (blank means prompt user to select).

Returns:

Void.

Class:

edmcommon.cmd.ChangePackageStatusCmd

changePassword

Change the current user's password.

Syntax:

changePassword()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.ChangePasswordCmd

clearSessionPackage

Remove the selected session package on the client to users have to select a package when making changes.

Syntax:

clearSessionPackage()

Parameters:

none

Returns:

Void.

Class:

edmclient.function.SelectSessionPackageFunction

close

Closes the specified open object window (form view, design view, or print preview).

Syntax:

close( 'objectType', 'objectName')

Parameters:

objectType - Type of object (table, query, form, report or function).

objectName - Name of the object.

Returns:

Void.

Class:

edmcommon.cmd.CloseFunction

closeActiveWindow

Closes the active window.

Syntax:

closeActiveWindow()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.CloseActiveWindowFunction

commitTransactions

Commit packages of transactions so they are sent to selected locations

Syntax:

commitTransactions( 'packageNameList', 'locationIdList', promptToCommit)

Parameters:

packageNameList - Semicolon separated list of package names to commit (if blank, prompt user to select packages)

locationIdList - Semicolon separated list of location numbers to commit packages. If blank, prompt user to select locations for each package or '*' will commit all sites in package.

promptToCommit - If true, ask user if he wants to commit transactions before prompting for locations and packages.

Returns:

Void.

Class:

edmcommon.cmd.CommitCmd

configureApplicationVersions

Configure known versions of application data sources.

Syntax:

configureApplicationVersions()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.ConfigureApplicationVersionsFunction

copy

Copies an object to the clipboard.

Syntax:

copy( 'objectType', 'objectName')

Parameters:

objectType - Type of object (table, query, form, report or function).

objectName - Name of the object.

Returns:

Void.

Class:

edmcommon.cmd.CopyFunction

copyAndRefreshSiteData

Copy data for selected tables from one site to other sites and refresh the tables at the other sites on the effective date.

Syntax:

copyAndRefreshSiteData( 'fromSiteId', 'toSiteIds', 'tableList', overwrite, copySharing, 'effectiveDate', forceProcessing, autoCommit)

Parameters:

fromSiteId - Site id to copy from (blank means prompt user).

toSiteIds - Comma-separated list of site IDs to copy to (blank means prompt user).

tableList - Name of a table list or a comma-separated list of table names to copy (blank means prompt user).

overwrite - True if destination site data should be overwritten if it exists.

copySharing - True if copied tables that are shared by the source site should be shared by the destination site.

effectiveDate - Date/time when data will be copied and refresh transaction sent out (local-specific format).

forceProcessing - True if transaction should be processed when only processing forced transactions.

autoCommit - True if refresh transaction should be committed as soon as it is generated.

Returns:

Void.

Class:

edmcommon.cmd.CopyAndRefreshSiteDataCmd

copyCompany

Create a new company by copying the configuration of an existing company.

A unique company ID is calculated by removing all characters from the company name except letters, digits, and underscores and adding digits if needed to make the name unique.

The configuration files for the company are copied from the sub-directory of the classes directory with the same name as the template company ID.

The company database is named EDMHQ_ + companyId.

NOTE: The system data source in the config file template must not contain a connect string because it contains the database name which is not replaced.

The company's security information (users, roles, etc) will be loaded from the policy file in the default company files directory.

There must be a role called 'Company Administrator' in the policy.xml file.

Syntax:

copyCompany( 'companyName', 'userName', 'userId', 'password', 'passwordConfirmation', 'templateCompanyName', 'authorizationClassName', 'authorizationParameters')

Parameters:

companyName - Name of the company to create.

userName - User's name.

userId - Login user ID which will be given the 'Company Administrator' role. Null or blank means don't create a user.

password - Login password.

passwordConfirmation - Login password confirmation.

templateCompanyName - Name of the existing company whose configuration will be copied to the new company.

authorizationClassName - Name of the class used to authorize the customer to create a company based on the customer ID.

authorizationParameters - Delimited ascii string of parameters sent to authorization method to determine if the user is authorized to create a company. Each parameter must be surrounded by double quotes, use two double quote characters to represent a double quote within the parameter.

Returns:

Unique ID of new company which can be used for company-specific directory or queue names.

Class:

edmcommon.cmd.CopyCompanyCmd

copyConfigurationVersionData

Copy the data from one configuration version to another version of the same configuration overwriting any existing data.

Syntax:

copyConfigurationVersionData( configurationTypeId, configurationId, sourceVersionId, destinatinVersionId)

Parameters:

configurationTypeId - ID of the configuration type for which the version data is being copied.

configurationId - ID of the configuration for which the version data is being copied.

sourceVersionId - ID of the version whose data will be copied.

destinatinVersionId - ID of the version to which the data will be copied.

Returns:

Site number of the destination version data site.

Class:

edmclient.plugin.mdm.cmd.CopyConfigVersionDataCmd

copyFoodCostPeriodData

Copy food cost data from one period to another.

Syntax:

copyFoodCostPeriodData( 'siteIdList', fromFiscalYear, fromPeriodNumber, toFiscalYear, toPeriodNumber)

Parameters:

siteIdList - Comma-separated list of site numbers whose date is to be copied (null, '', or '?' means prompt user to select, '*' means all locations)

fromFiscalYear - Fiscal year to copy from.

fromPeriodNumber - Period number (1-13) to copy from.

toFiscalYear - Fiscal year to copy from.

toPeriodNumber - Period number (1-13) to copy from.

Returns:

Void.

Class:

edmclient.plugin.UserClientPlugins

copyLocationData

Copy site data for a list of tables to other sites. DEPRECATED Use copySiteData instead.

Syntax:

copyLocationData( 'fromLocation', 'toLocations', 'tableList')

Parameters:

fromLocation - Id of the location to copy from (blank means prompt user).

toLocations - List of comma-separated location id's of the locations to copy to (blank means prompt user).

tableList - List of comma-separated table names of the tables to whose location data is to be copied

Returns:

Void.

Class:

edmcommon.cmd.CopySiteDataCmd

copySelectedObject

Copies the application objected selected on the main menu to the clipboard.

Syntax:

copySelectedObject()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.CopySelectedObjectFunction

copySiteData

Copy data for selected tables from one location to another location

Syntax:

copySiteData( 'fromSiteId', 'toLocations', 'tableList', overwrite, copySharing)

Parameters:

fromSiteId - Site id to copy from (blank means prompt user).

toLocations - Comma-separated list of site IDs to copy to (blank means prompt user).

tableList - Name of a table list or a comma-separated list of table names to copy (blank means prompt user).

overwrite - True if destination site data should be overwritten if it exists.

copySharing - True if copied tables that are shared by the source site should be shared by the destination site.

Returns:

Void.

Class:

edmcommon.cmd.CopySiteDataCmd

copySiteSubscriptions

Copy the configuration version subscriptions from one site to other sites leaving the version ID null. If the source site has no subscriptions or the list of configuration ID's to copy is empty, do nothing.

Syntax:

copySiteSubscriptions( 'sourceSiteId', 'destinationSiteIdList', 'configurationIdList')

Parameters:

sourceSiteId - ID of the site whose subscriptions are to be copied (blank means prompt user).

destinationSiteIdList - Comma-delimited list of destination site IDs that will be subscribed to the same configurations as the source site (blank means prompt user).

configurationIdList - Comma-delimited list of configuration type ID and configuration ID pairs (typeID,configID) for the configurations to be copied. For example, to copy the Eastern configuration (config ID = 2) of the Items configuration type (ID = 1) and the TierA configuration (config ID = 3) of the Prices configuration type (ID = 4), the string would be "1,2,4,3" (Items,Eastern,Prices,TierA) (blank means prompt user).

Returns:

None.

Class:

edmclient.plugin.mdm.cmd.CopySiteSubscriptionsCmd

copyVersionData

Copy the data from one version to another version for all configurations overwriting any existing data.

Syntax:

copyVersionData( 'sourceVersionId', 'destinatinVersionId')

Parameters:

sourceVersionId - ID of the version whose data will be copied.

destinatinVersionId - ID of the version to which the data will be copied.

Returns:

None.

Class:

edmclient.plugin.mdm.cmd.CopyVersionDataCmd

createConfigurationVersionDataSite

Creates a data site to hold version data for configuration version. The ID of the new site will be an unused, negative site number. The name of the site will be the name of the configuration plus a hyphen plus the name of the version. Each table in the configuration type will be added to the list of managed site tables. If there is a previous version of the configuration then the data from the previous version will be copied to the new version.

Syntax:

createConfigurationVersionDataSite( configurationTypeId, configurationId, versionId)

Parameters:

configurationTypeId - ID of the configuration type for which the version data site is being created.

configurationId - ID of the configuration for which the version data site is being created.

versionId - ID of the version for which the version data site is being created.

Returns:

Site number of the newly created version data site.

Class:

edmclient.plugin.mdm.cmd.CreateConfigVersionDataSiteCmd

createConfigurationVersionsCmd

Create configuration versions for the given configuration type and configuration.

Syntax:

createConfigurationVersionsCmd( configurationTypeId, configurationId)

Parameters:

configurationTypeId - ID of the configuration type.

configurationId - ID of the configuration.

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.CreateConfigurationVersionsCmd

createRemoteInstaller

Create an installation program that can be downloaded and used to install EDM at a remote site with pre-configured settings for the current company.

The function copies CompileInfo.txt from webapps/edm/company/[companyId]/RemoteInstaller to webapps/edm/WEB-INF/RemoteInstaller then executes webapps/edm/WEB-INF/RemoteInstaller/build.bat.The CompileInfo.txt file in each company directory contains company-specific information needed to create the remote installation program.

See the Xpient wiki page "Automated Setup of New Remote Sites" in the "EDM Documentation" section for more information.

Syntax:

createRemoteInstaller()

Parameters:

none

Returns:

URL of page where installer can be downloaded.

Class:

edmcommon.cmd.CreateRemoteInstallerCmd

createTransactionTriggers

Create SQL scripts so triggers on application tables at remote sites can generate EDM transactions.

Creates a SQL script called EDM_Transaction_Functions.sql that creates functions in the EDM database that can be called by triggers in the remote application database to generate transactions. Also creates a script called App_Transaction_Triggers.sql to create triggers on the tables in the given table list that generate transactions in the EDM audit table on insert, update, and delete. Currently this function only supports SQL Server databases.

Syntax:

createTransactionTriggers( 'tableListName')

Parameters:

tableListName - Name of the table list containing the names of the tables to which triggers should be added.

Returns:

Void.

Class:

edmcommon.cmd.CreateTransactionTriggersCmd

cut

Cuts an object to the clipboard.

Syntax:

cut( 'objectType', 'objectName')

Parameters:

objectType - Type of object (table, query, form, report or function).

objectName - Name of the object.

Returns:

Void.

Class:

edmcommon.cmd.CutFunction

cutSelectedObject

Cuts the application objected selected on the main menu to the clipboard.

Syntax:

cutSelectedObject()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.CutSelectedObjectFunction

date

Get current date.

Syntax:

date( 'format')

Parameters:

format - Format string describing how the date should be formatted.

Returns:

String containing current date.

Class:

edmcommon.function.CommonFunctions

dateToNumber

Converts a date to a number

Syntax:

dateToNumber( 'date')

Parameters:

date - Date to convert

Returns:

Number representing the date

Class:

edmcommon.function.CommonFunctions

dateToString

Converts a date to a character string

Syntax:

dateToString( 'date', 'format')

Parameters:

date - Date to convert

format - Format string to use

Returns:

String representation of the date

Class:

edmcommon.function.CommonFunctions

dateToTimestamp

Converts a date to a timestamp

Syntax:

dateToTimestamp( 'date')

Parameters:

date - Date to convert

Returns:

Timestamp representing the date with the time set to 00:00:00

Class:

edmcommon.function.CommonFunctions

day

Returns the day value of a date

Syntax:

day( 'date')

Parameters:

date - Date to get the day from

Returns:

Day number (1-31)

Class:

edmcommon.function.CommonFunctions

delete

Deletes an object.

Syntax:

delete( 'objectType', 'objectName')

Parameters:

objectType - Type of object (table, query, form, report or function).

objectName - Name of the object.

Returns:

Void.

Class:

edmcommon.cmd.DeleteFunction

deleteConfiguration

Delete a configuration with the given configuration type and configuration. Deletes are cascaded to all associated Configuration Versions and DataSites.

Syntax:

deleteConfiguration( configurationTypeId, configurationId)

Parameters:

configurationTypeId - ID of the configuration type.

configurationId - ID of the configuration.

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.DeleteConfigurationCmd

deleteDataSource

Delete the data source with the given name from the list of data sources for this company.

Syntax:

deleteDataSource( 'name')

Parameters:

name - Data source name used by the system.

Returns:

True if data source was deleted otherwise false.

Class:

edmcommon.cmd.DeleteDataSourceCmd

deleteFoodCostPeriodData

Delete food cost data for one period in a fiscal year.

Syntax:

deleteFoodCostPeriodData( 'siteIdList', fiscalYear, periodNumber)

Parameters:

siteIdList - Comma-separated list of site numbers whose date is to be deleted (null, '', or '?' means prompt user to select, '*' means all locations)

fiscalYear - Fiscal year to delete.

periodNumber - Period number (1-13) to delete.

Returns:

Void.

Class:

edmclient.plugin.UserClientPlugins

deleteLocationData

Delete all data from selected tables at selected locations.

Syntax:

deleteLocationData( 'locationIdList', 'tableList')

Parameters:

locationIdList - Comma-separated list of location id's from which data should be deleted (null, '', or '?' means prompt user to select, '*' means all locations).

tableList - List of table names whose data is to be deleted (null, '', or '?' means prompt user to select).

Returns:

Void

Class:

edmcommon.cmd.DeleteLocationDataCmd

deleteOrphanedRecords

Delete menus, attachments, prices, and category links that refer to non-existent items.

Syntax:

deleteOrphanedRecords()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.UserClientPlugins

deleteRecord

Deletes the selected records (or the current record if none selected) on the active form.

Syntax:

deleteRecord()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.DeleteRecordFunction

deleteRow

Delete a row or rows from a table for a given list of sites that match the given columns and values in the table with the given name.

This function can be called in the AfterDelete event to delete a row in the product type table. For example, to delete rows in the TNG_dbo_ProductTypes table after the user inserts a row in the TNG_dbo_Products table, set the afterInsert property of the Product form to: "=addRow( 'TNG_dbo_ProductTypes', getNamedControlValues( 'id,name,description' ), getSelectedSites() )"

Syntax:

deleteRow( 'tableName', 'namedColumnValues', 'siteIdList')

Parameters:

tableName - Name of a table.

namedColumnValues - List of column names and values of the form: "name1","value1","name2","value2"...

siteIdList - Comma-delimited list of sited ID's.

Returns:

Void.

Class:

edmcommon.cmd.DeleteRowCmd

deleteSelectedObject

Deletes the application objected selected on the main menu.

Syntax:

deleteSelectedObject()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.DeleteSelectedObjectFunction

deleteTable

Deletes a table.

Syntax:

deleteTable( 'tableName', deletePhysicalTable)

Parameters:

tableName - Name of the table.

deletePhysicalTable - True if system should delete the physical table from the database as well.

Returns:

Void.

Class:

edmcommon.cmd.DeleteTableFunction

deleteTableList

Delete a table list.

Syntax:

deleteTableList( 'tableListName')

Parameters:

tableListName - Name of table list to delete.

Returns:

Deleted table list or null if not found.

Class:

edmcommon.cmd.EditSnapshotTablesCmd

deleteTransactionFilesFromAmazon

Delete transaction files (*.xml and *.fil) from the Amazon Simple Storage Service (S3).

Syntax:

deleteTransactionFilesFromAmazon( 'siteIdList', 'bucketName', 'prefix', 'encryptedCredentials')

Parameters:

siteIdList - Comma-separated list of site IDs to delete (blank to prompt user, * for all locations).

bucketName - Name of Amazon S3 bucket containing incoming and outgoing folders.

prefix - Common prefix of all transaction file names to be deleted without the site ID path segment, e.g. "outgoing/".

encryptedCredentials - AWS credentials encrypted with the EncryptAmazonCredentialsCmd object.

Returns:

Void

Class:

edmcommon.cmd.DeleteTransactionFilesFromAmazonCmd

deployMasterChanges

Deploy master data to application tables in the table map.

Syntax:

deployMasterChanges( 'deployTypeId', setAppliedToNull, 'versionId', 'appIdList')

Parameters:

deployTypeId - ID of the type of deployment being made which determines which site property and value is used to identify sited included in the deployment and the data sources and schemas used for the application tables.

setAppliedToNull - True if the applied date of the subscription records for sites included in the deployment should be set to null to force deployment of all tables.

versionId - ID of the version to be deployed, null or blank means deploy data for all subscribed versions.

appIdList - Comma-delimited list of app ID's to deploy or "*" to deploy to all apps.

Returns:

Number of sites that were deployed.

Class:

edmclient.plugin.mdm.cmd.DeployMasterChangesCmd

design

Opens an object in design view.

Syntax:

design( 'objectType', 'objectName')

Parameters:

objectType - Type of object (table, query, form, report or function).

objectName - Name of the object.

Returns:

Void.

Class:

edmcommon.cmd.EditObjectCmd

designForm

Opens a form in design view.

Syntax:

designForm( 'objectName')

Parameters:

objectName - Name of the form.

Returns:

Void.

Class:

edmcommon.cmd.EditObjectCmd

designNew

Opens a new object in design view.

Syntax:

designNew( 'objectType')

Parameters:

objectType - Type of object (table, query, form, report or function).

Returns:

Void.

Class:

edmcommon.cmd.DesignNewFunction

disableControls

Disable the controls with the given names on the active form.

Syntax:

disableControls( 'controlNames')

Parameters:

controlNames - Comma-delimited list of control names.

Returns:

None

Class:

edmclient.function.SetControlPropertyFunction

disableFormControls

Disable the controls with the given names on the given form.

Syntax:

disableFormControls( 'formName', 'controlNames')

Parameters:

formName - Name of the form.

controlNames - Comma-delimited list of control names.

Returns:

None

Class:

edmclient.function.SetControlPropertyFunction

displayHelp

Display help for the specified topic.

Syntax:

displayHelp( 'helpTopic')

Parameters:

helpTopic - Help topic to display.

Returns:

Void.

Class:

edmcommon.cmd.DisplayHelpFunction

dumpEmmaCoverageData

Dump Emma coverage data into the specified file

Syntax:

dumpEmmaCoverageData( 'fileName')

Parameters:

fileName - Name of file to dump Emma coverage data into.

Returns:

Void.

Class:

edmcommon.cmd.DumpEmmaCoverageDataCmd

dumpProfile

Disable profiling and write profile report to log.

Syntax:

dumpProfile()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.DumpProfileCmd

editCommitListeners

Edit list of email addresses to be notified when packages are committed.

Syntax:

editCommitListeners()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.EditCommitListenersFunction

editConfigurationSubscriptions

Edit Configuration Subscriptions.

Syntax:

editConfigurationSubscriptions()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.EditConfigurationSubscriptionsFunction

editConfigurationTypes

Edit Configuration Types.

Syntax:

editConfigurationTypes()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.EditConfigurationTypesFunction

editConfigurationVersions

Edit Configuration Versions.

Syntax:

editConfigurationVersions()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.EditConfigurationVersionsFunction

editEmailList

Edit a named list of email addresses.

Syntax:

editEmailList( 'tabTitle', 'listLabel', 'emailListName')

Parameters:

tabTitle - Text to display on the title portion of the client tab.

listLabel - Text to display above the list of rows user can select to edit.

emailListName - Name of the email list (must be valid XML element name).

Returns:

Void.

Class:

edmcommon.cmd.EditEmailListFunction

editFileSharing

View and modify table sharing among locations.

Syntax:

editFileSharing()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.EditFileSharingFunction

editIrisConfig

Edit IRIS configuration.

Syntax:

editIrisConfig()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.iris.EditIrisComboAndShakePricesFunction

editIrisConfigGroups

Edit IRIS config groups.

Syntax:

editIrisConfigGroups()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.iris.configgroupeditor.ConfigGroupEditorFunction

editIrisItemMenus

Edit IRIS item menus and buttons.

Syntax:

editIrisItemMenus( 'useMacros', 'range')

Parameters:

useMacros - True (1) if using a version of IRIS that allows buttons to be assigned to menu macros.

range - The range of item menu numbers that the user is allowed to edit. An example would be '1,3,5-10' to exclude item menu numbers 2 and 4 in the range 1-10.

Returns:

Void.

Class:

edmclient.plugin.iris.EditIrisItemMenusFunction

editIrisMenus

Edit IRIS menus and buttons.

Syntax:

editIrisMenus( 'useMacros')

Parameters:

useMacros - True (1) if using a version of IRIS that allows buttons to be assigned to menu macros.

Returns:

Void.

Class:

edmclient.plugin.iris.EditIrisMenusFunction

editIrisTaxRules

Edit IRIS tax rules.

Syntax:

editIrisTaxRules()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.iris.taxeditor.TaxRuleEditorFunction

EditMobileCategoryItemSequence

Edit Mobile Category Item Display Sequence.

Syntax:

EditMobileCategoryItemSequence()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.tacobell.mobilecategoryitem.EditMobileCategoryItemSequenceFunction

EditMobileCategorySequence

Edit Mobile Category Display Sequence.

Syntax:

EditMobileCategorySequence()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.tacobell.mobilecategory.EditMobileCategorySequenceFunction

EditMobileModifierSequence

Edit Mobile Modifier Display Sequence.

Syntax:

EditMobileModifierSequence()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.tacobell.mobileaddon.EditMobileAddOnSequenceFunction

editRoles

View and modify roles to which system users may be assigned.

Syntax:

editRoles()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.EditRolesFunction

editScheduledTasks

Open form to edit tasks scheduled on the server.

Syntax:

editScheduledTasks()

Parameters:

none

Returns:

Void.

Class:

edmclient.function.EditScheduledTasksFunction

editServerTextFile

Edit a text file on the server.

Syntax:

editServerTextFile( 'filePath')

Parameters:

filePath - Path and name of the file to edit. Blank means edit a new empty file.

Returns:

Void.

Class:

edmclient.function.EditServerTextFileFunction

editSharedTableGroups

Edit groups of tables that are shared together.

Syntax:

editSharedTableGroups()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.EditSharedTableGroupsFunction

editSharing

View and modify table sharing among locations.

Syntax:

editSharing()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.EditSharingFunction

editUsers

View and modify system users.

Syntax:

editUsers()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.EditUsersFunction

editVersions

Edit Versions.

Syntax:

editVersions()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.EditVersionsFunction

editVersionSubscriptions

Edit Version Subscriptions.

Syntax:

editVersionSubscriptions()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.EditVersionSubscriptionsFunction

enableControls

Enable the controls with the given names on the active form.

Syntax:

enableControls( 'controlNames')

Parameters:

controlNames - Comma-delimited list of control names.

Returns:

None

Class:

edmclient.function.SetControlPropertyFunction

enableFormControls

Enable the controls with the given names on the given form.

Syntax:

enableFormControls( 'formName', 'controlNames')

Parameters:

formName - Name of the form.

controlNames - Comma-delimited list of control names.

Returns:

None

Class:

edmclient.function.SetControlPropertyFunction

enableProfile

Enable profiling.

Syntax:

enableProfile()

Parameters:

none

Returns:

True if profiling was previously enable.

Class:

edmcommon.cmd.EnableProfileCmd

encryptAmazonCredentials

Encrypt a property file containing Amazon Web Services (AWS) credentials.

Syntax:

encryptAmazonCredentials( 'propertyFile')

Parameters:

propertyFile - Property file containing AWS accessKey and secretKey properties.

Returns:

Void

Class:

edmcommon.cmd.EncryptAmazonCredentialsCmd

evaluateExpressionAtRemoteSites

Send an expression to a list of remote sites which will evaluate the expression on the server. Only server-side functions may be included in the expression.

Syntax:

evaluateExpressionAtRemoteSites( 'expression', 'siteIdList')

Parameters:

expression - Expression to evaluate. For example: processTransactions('*')

siteIdList - Comma-delimited list of remote site IDs that are to evaluate the expression.

Returns:

Void.

Class:

edmclient.function.EvaluateExpressionAtRemoteSitesFunction

executeDirectSQL

Directly execute the given SQL statement on the given data source and return the results in a DataSet. If query is not a select statement, execute the SQL statement and return empty DataSet. Use caution to avoid exceeding available memory.

Syntax:

executeDirectSQL( 'dataSourceName', 'sql')

Parameters:

dataSourceName - Name of the EDM data source where the query is to execute (null or blank means use system data source).

sql - SQL statement to execute.

Returns:

DataSet

Class:

edmcommon.cmd.ExecuteQueryCmd

exit

Exits from the program.

Syntax:

exit()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.ExitFunction

exportData

Exports data from a table or query to a text file.

Syntax:

exportData( 'filename', addNameRow, isDelimited, 'delimiter', 'columnLengths', 'dateFormat', 'source')

Parameters:

filename - Name of the text file in which to store the data.

addNameRow - T/F should the first row of the text file contain column names?.

isDelimited - T/F should the text file be delimited (as opposed to fixed length fields)?.

delimiter - Character that separates the fields (Comma, Tab, \ASCII code or character).

columnLengths - Length of each field separated by semicolons ';' for fixed length fields.

dateFormat - Format string that describes how dates should appear in the text file.

source - Name of the table or query to export.

Returns:

Void.

Class:

edmcommon.cmd.ExportDataFunction

exportFoodCostFiles

Create ascii export files for CKE food cost system

Syntax:

exportFoodCostFiles( 'siteIdList', 'fiscalYear', 'periodNumber')

Parameters:

siteIdList - Comma-separated list of site numbers whose files are to be created (null, '', or '?' means prompt user to select, '*' means all locations)

fiscalYear - Fiscal year to export (null, '', or '?' means get from Forms:[ExportFoodCostFiles]:FiscalYear)

periodNumber - Period number (1-13) to export (null, '', or '?' means get from Forms:[ExportFoodCostFiles]:PeriodNumber)

Returns:

Void.

Class:

edmclient.plugin.UserClientPlugins

exportSecurityPolicyToXml

Export users, roles, and other security settings to XML file.

Syntax:

exportSecurityPolicyToXml( 'file')

Parameters:

file - File path and name.

Returns:

Void.

Class:

edmcommon.cmd.ExportSecurityPolicyToXmlCmd

exportSelectedDataToFile

Exports data from a table or query to a text file. Can be run unattended.

Syntax:

exportSelectedDataToFile( 'siteList', useShareGroupNumbers, 'filePathAndName', addNameRow, isDelimited, 'delimiter', 'columnLengths', 'dateFormat', 'source')

Parameters:

siteList - Comma delimited list of the sites to be exported.

useShareGroupNumbers - True/False whether or not to use the share group numbers rather than the site list numbers

filePathAndName - Name of the text file in which to store the data.

addNameRow - T/F should the first row of the text file contain column names?.

isDelimited - T/F should the text file be delimited (as opposed to fixed length fields)?.

delimiter - Character that separates the fields (Comma, Tab, \ASCII code or character).

columnLengths - Length of each field separated by semicolons ';' for fixed length fields.

dateFormat - Format string that describes how dates should appear in the text file.

source - Name of the table or query to export.

Returns:

Void.

Class:

edmcommon.cmd.ExportSelectedDataToFileFunction

extractTestDatabaseChanges

Extract changes to a test database to transaction files

Syntax:

extractTestDatabaseChanges( 'snapshotName', 'packageName', 'packageDescription')

Parameters:

snapshotName - Name of snapshot containing list of tables to refresh (blank means prompt user to select).

packageName - Name of package to hold transactions (blank means prompt user to select).

packageDescription - Description of package if a new package is to be created

Returns:

Void.

Class:

edmclient.ClientFunctions

findNextRecord

Finds next record on the current form or spreadsheet using current search options.

Syntax:

findNextRecord()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.FindNextRecordFunction

findRecord

Finds record on the current form or spreadsheet.

Syntax:

findRecord( 'searchString', caseSensitive, allFields, partOfField, forward, checkCurrentRecord)

Parameters:

searchString - String to search for.

caseSensitive - T/F should search be case sensitive.

allFields - T/F search all fields.

partOfField - 0=whole field, 1=beginning of field, 2=any part of field.

forward - T/F search forward.

checkCurrentRecord - T/F check current record.

Returns:

Void.

Class:

edmcommon.cmd.FindRecordFunction

generateFunctionHelp

Generate HTML help file for a list of PluginLoader classes.

Syntax:

generateFunctionHelp( 'pluginLoaderClasses', 'destinationHtmlFile', isClassListForClient)

Parameters:

pluginLoaderClasses - Comma-delimited list of PluginLoader class names whose functions should be included in the help file.

destinationHtmlFile - Path and name of HTML help file to generate.

isClassListForClient - True if the functions are in client side classes, else False if they are in server side classes.

Returns:

Void

Class:

edmcommon.cmd.GenerateFunctionHelpCmd

generateSnapshot

Generate snapshot of data in snapshot tables

Syntax:

generateSnapshot( 'snapshotName')

Parameters:

snapshotName - Name of the snapshot to generate (blank to prompt user).

Returns:

Void.

Class:

edmcommon.cmd.GenerateSnapshotFunction

generateTestDatabase

Generate a test database with data from selected locations

Syntax:

generateTestDatabase( 'snapshotName', 'selectedLocations', 'effectiveDate', 'terminationDate', allowMultipleLocations, 'tableShareGroups')

Parameters:

snapshotName - Name of snapshot containing list of tables to refresh (blank means prompt user to select).

selectedLocations - List of comma-separated location ID's of the locations from which to get the test records (blank means prompt user to select).

effectiveDate - Date that changes made to the test database (if any) will be applied to the system database.

terminationDate - Date that changes made to the test database (if any) will be reversed in the system database.

allowMultipleLocations - If the selected locations list is blank, this controls whether or not the user can select multiple locations when prompted.

tableShareGroups - Name of the table whose share groups are to be shown if user is prompted to select locations.

Returns:

Void.

Class:

edmcommon.cmd.GenerateTestDatabaseCmd

getAppObject

Returns application object with specified type and name or null if not found.

Syntax:

getAppObject( 'objectType', 'objectName')

Parameters:

objectType - Type of application object (0=table, 1=query, 2=form, 3=report, 4=function).

objectName - Name of application object.

Returns:

Application object or null if not found.

Class:

edmcommon.cmd.GetAppObjectCmd

getBackgroundProcessViewer

See a window of processes that are running.

Syntax:

getBackgroundProcessViewer()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.BackgroundProcessViewerFunction

getClientPropertyBoolean

Gets a client property associated with the given property name.

Syntax:

getClientPropertyBoolean( 'name', defaultValue)

Parameters:

name - Name of the client property.

defaultValue - Default boolean value of the client property.

Returns:

Default value if no property exists with the given name.

Class:

edmclient.function.SetClientPropertyFunction

getClientPropertyInteger

Gets a client property associated with the given property name.

Syntax:

getClientPropertyInteger( 'name', defaultValue)

Parameters:

name - Name of the client property.

defaultValue - Default integer value of the client property.

Returns:

Default value if no property exists with the given name.

Class:

edmclient.function.SetClientPropertyFunction

getClientPropertyString

Gets a client property associated with the given property name.

Syntax:

getClientPropertyString( 'name', 'defaultValue')

Parameters:

name - Name of the client property.

defaultValue - Default value of the client property.

Returns:

Default value if no property exists with the given name.

Class:

edmclient.function.SetClientPropertyFunction

getCompanyName

Returns the name of the currently selected company.

Syntax:

getCompanyName()

Parameters:

none

Returns:

String.

Class:

edmclient.function.GetCompanyNameFunction

getConfigProperty

Get configuration property value.

Get value of the property in the configuration file with the given case-sensitive name or null if not found.

Syntax:

getConfigProperty( 'propertyName')

Parameters:

propertyName - Name of the property.

Returns:

Property value or null if not found.

Class:

edmcommon.cmd.GetConfigPropertyCmd

getConfigPropertyWithDefault

Get configuration property value.

Get value of the property in the configuration file with the given case-sensitive name or the given default value if not found.

Syntax:

getConfigPropertyWithDefault( 'propertyName', 'defaultValue')

Parameters:

propertyName - Name of the property.

defaultValue - Default value to return if property not found.

Returns:

Property value or the given default value if not found.

Class:

edmcommon.cmd.GetConfigPropertyCmd

getControlValueRow

Create row with column values from the given list of controls on the active form.

Syntax:

getControlValueRow( 'controlNames')

Parameters:

controlNames - Comma-delimited list of names of the controls to use for row values.

Returns:

String containing delimited ascii values.

Class:

edmclient.function.GetControlValueRowFunction

getCurrentUserId

Return the ID of the user that is currently logged in or \"\" if no user is logged in.

Syntax:

getCurrentUserId()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.CurrentUserIdFunction

getEffectiveDate

Get date/time transactions becomes effective for the active form.

Syntax:

getEffectiveDate()

Parameters:

none

Returns:

Effective date in default system format.

Class:

edmclient.function.GetEffectiveDateFunction

getEstimatedRowCount

Get estimated number of rows in the data source of the given form. Will use active form is no form name given.

Syntax:

getEstimatedRowCount( 'formName')

Parameters:

formName - Name of the form.

Returns:

Estimated number of rows.

Class:

edmclient.function.GetEstimatedRowCountFunction

getForceProcessing

Get flag for whether transactions for the active form should be processed when only processing forced transactions.

Syntax:

getForceProcessing()

Parameters:

none

Returns:

True if transactions for the active form should be processed when only processing forced transactions.

Class:

edmclient.function.GetForceProcessingFunction

getFormNamedControlValues

Get a string containing the names and values of a list of controls from a form. Example: "name1","value1","name2","value2",...

Syntax:

getFormNamedControlValues( 'formName', 'controlNameList')

Parameters:

formName - Name of the form with the controls.

controlNameList - Comma-delimited list of control names whose names and values will be added to the string.

Returns:

String.

Class:

edmclient.function.ControlValueFunctions

getFormValue

Gets the value of the given control on the given form.

Syntax:

getFormValue( 'formName', 'controlName')

Parameters:

formName - Name of the form the control is on.

controlName - Control whose value is to be returned.

Returns:

String.

Class:

edmclient.function.ControlValueFunctions

getIniValue

Returns value for the given key from the given ini file or null if not found.

Syntax:

getIniValue( 'iniFileName', 'key')

Parameters:

iniFileName - Path and name of ini file. Path may be absolute or relative.

key - Key whose value is to be returned.

Returns:

Ini value or null if not found.

Class:

edmcommon.cmd.GetIniFileValueCmd

getLastDeploymentInfo

Get the last deployment date and user name with the given deployment type.

Syntax:

getLastDeploymentInfo( 'deployTypeId', 'versionId')

Parameters:

deployTypeId - The ID of the deployemnt type, which is used to filter the sites.

versionId - The ID of the version.

Returns:

String.

Class:

edmclient.plugin.mdm.cmd.GetLastDeploymentInfoCmd

getLastVersionChangeInfo

Get the last change date and user name with the given version.

Syntax:

getLastVersionChangeInfo( 'versionId')

Parameters:

versionId - The ID of the version.

Returns:

String.

Class:

edmclient.plugin.mdm.cmd.GetLastVersionChangeInfoCmd

getMasterTableConfigurationType

Gets the Configuration Type for the given table with the given name.

Syntax:

getMasterTableConfigurationType( 'tableName')

Parameters:

tableName - The name of the table to check.

Returns:

The ConfigurationType for the given table with the given name.

Class:

edmclient.plugin.mdm.cmd.GetMasterTableConfigurationTypeCmd

getNamedControlValues

Get a string containing the names and values of a list of controls from the active form. Example: "name1","value1","name2","value2",...

Syntax:

getNamedControlValues( 'controlNameList')

Parameters:

controlNameList - Comma-delimited list of control names whose names and values will be added to the string.

Returns:

String.

Class:

edmclient.function.ControlValueFunctions

getNextUnusedId

Gets the next unused ID for the given table and column, optionally within a range.

Syntax:

getNextUnusedId( 'tableName', 'columnName', 'minValue', 'maxValue')

Parameters:

tableName - The name of the table containing the column.

columnName - The name of the column to return the next ID value for.

minValue - The minimum value to return. If not supplied, will use 1.

maxValue - The maximum value to return. If not supplied, will use Integer.MAX_VALUE.

Returns:

Integer.

Class:

edmcommon.cmd.GetNextUnusedIdCmd

getNumberOfAssignedSites

Get the number of sites assigned to the given version.

Syntax:

getNumberOfAssignedSites( 'deployTypeId', 'versionId')

Parameters:

deployTypeId - The ID of the deployemnt type, which is used to filter the sites.

versionId - The ID of the version.

Returns:

Integer.

Class:

edmclient.plugin.mdm.cmd.GetNumberOfAssignedSitesCmd

getNumberOfUnassignedSites

Get the number of sites that are not assigned to the given version.

Syntax:

getNumberOfUnassignedSites( 'deployTypeId', 'versionId')

Parameters:

deployTypeId - The ID of the deployemnt type, which is used to filter the sites.

versionId - The ID of the version.

Returns:

Integer.

Class:

edmclient.plugin.mdm.cmd.GetNumberOfUnassignedSitesCmd

getPackageDescription

Get description of package that contains transaction for the active form.

Syntax:

getPackageDescription()

Parameters:

none

Returns:

Package description.

Class:

edmclient.function.GetPackageDescriptionFunction

getPackageName

Get name of package that contains transaction for the active form.

Syntax:

getPackageName()

Parameters:

none

Returns:

Package name.

Class:

edmclient.function.GetPackageNameFunction

getPropertyFileValue

Get the value of a property in a property file.

Syntax:

getPropertyFileValue( 'propertyName', 'propertyFileName')

Parameters:

propertyName - Name of the property whose value is to be returned.

propertyFileName - Path and name of property file.

Returns:

Property value

Class:

edmcommon.cmd.GetPropertyFileValueCmd

getSchemaVersions

Returns a list of known application database schemas supported by the system.

Syntax:

getSchemaVersions()

Parameters:

none

Returns:

List of known application database schemas.

Class:

edmcommon.cmd.SchemaVersionsFunction

getSelectedSites

Get the selected sites for the active form.

Syntax:

getSelectedSites()

Parameters:

none

Returns:

Comma delimited list of selected site IDs for the active form.

Class:

edmclient.function.GetSelectedSitesFunction

getServerCallsPerSecond

Returns the average number of calls per second that can be made to the server after sending as many calls to the server as possible for 5 seconds.

Syntax:

getServerCallsPerSecond()

Parameters:

none

Returns:

Integer.

Class:

edmcommon.cmd.GetServerTimeCmd

getServerFile

Return the bytes of a file from the server.

Syntax:

getServerFile( 'filename')

Parameters:

filename - Name and relative path of file to be returned.

Returns:

Bytes in the specified file from the server.

Class:

edmclient.ClientFunctions

getServerFileList

Gets a list of files in the specified directory on the server.

Syntax:

getServerFileList( 'directory')

Parameters:

directory - Directory on the server (relative to application base directory) whose files are to be returned.

Returns:

Array of objects containing file attributes.

Class:

edmclient.ClientFunctions

getServerTime

Returns the current system time on the server in milliseconds since 1/1/1970 UTC.

Syntax:

getServerTime()

Parameters:

none

Returns:

Integer.

Class:

edmcommon.cmd.GetServerTimeCmd

getSessionPackageName

Returns the name of the currently selected package.

Syntax:

getSessionPackageName()

Parameters:

none

Returns:

String.

Class:

edmclient.function.GetSessionPackageNameFunction

getSessionPackageVersionID

Returns the ID of the currently selected package's version or null if there is no selected package or if the selected package doesn't have a version.

Syntax:

getSessionPackageVersionID()

Parameters:

none

Returns:

Integer.

Class:

edmclient.function.GetSessionPackageVersionNameFunction

getSessionPackageVersionName

Returns the name of the currently selected package's version or null if there is no selected package or if the selected package doesn't have a version.

Syntax:

getSessionPackageVersionName()

Parameters:

none

Returns:

String.

Class:

edmclient.function.GetSessionPackageVersionNameFunction

getSessions

Returns a list of the current active sessions on the server.

Syntax:

getSessions()

Parameters:

none

Returns:

String.

Class:

edmcommon.cmd.GetSessionsCmd

getSystemProperty

Get the value of a property in the system.properties file.

Syntax:

getSystemProperty( 'propertyName', 'DefaultValue')

Parameters:

propertyName - Name of the property.

DefaultValue - Value to return if the property is not found.

Returns:

Value of system property if found, otherwise the default value.

Class:

edmcommon.cmd.GetSystemPropertyFunction

getTableAndQueryList

Get a sorted list of tables and queries in this application separated by semicolons.

Syntax:

getTableAndQueryList()

Parameters:

none

Returns:

Sorted list of tables and queries separated by semicolons.

Class:

edmcommon.cmd.TableAndQueryListFunction

getTableList

Get a sorted list of tables in this application separated by semicolons.

Syntax:

getTableList()

Parameters:

none

Returns:

Sorted list of tables and queries separated by semicolons.

Class:

edmcommon.cmd.TableListFunction

getTerminationDate

Get date/time transactions terminate for the active form.

Syntax:

getTerminationDate()

Parameters:

none

Returns:

Termination date in default system format.

Class:

edmclient.function.GetTerminationDateFunction

getText

Returns the text from the given control.

Syntax:

getText( 'controlName')

Parameters:

controlName - Name of the control.

Returns:

Text from the given control.

Class:

edmclient.function.ControlValueFunctions

getTransactionViewer

See a dialog of recent file transactions that are either in yellow or red status.

Syntax:

getTransactionViewer()

Parameters:

none

Returns:

Void

Class:

edmcommon.cmd.TransactionViewerFunction

getUnupdatableSites

Return comma-delimited list of unupdatable sites for the active form.

Syntax:

getUnupdatableSites()

Parameters:

none

Returns:

List of sites.

Class:

edmcommon.cmd.UnupdatableSitesFunction

getUpdatableSites

Return comma-delimited list of updatable sites for the active form.

Syntax:

getUpdatableSites()

Parameters:

none

Returns:

List of sites.

Class:

edmcommon.cmd.UpdatableSitesFunction

getUserInput

Prompts user to enter a value.

Syntax:

getUserInput( 'title', 'prompt', 'defaultValue', password)

Parameters:

title - Dialog box title.

prompt - Prompt text to tell user what to enter.

defaultValue - Default value in the input field.

password - T/F is this a password field that should not echo the characters entered.

Returns:

Value entered by the user or blank if cancelled.

Class:

edmcommon.cmd.GetUserInputFunction

getValue

Gets data for the specified identifier.

Syntax:

getValue( 'identifier')

Parameters:

identifier - Name of the identifier.

Returns:

Identifier value if successful, otherwise null.

Class:

edmclient.function.ControlValueFunctions

getValueListOfUsersWithRole

Get a value list of users with a given role separated by semicolons.

Syntax:

getValueListOfUsersWithRole( 'roleName')

Parameters:

roleName - Name of role.

Returns:

String.

Class:

edmcommon.cmd.GetValueListOfUsersWithRoleCmd

getVersion

Return the current version of EDM

Syntax:

getVersion()

Parameters:

none

Returns:

The current version of EDM

Class:

edmcommon.function.CommonFunctions

gotoControl

Moves cursor to a control.

Syntax:

gotoControl( 'controlName')

Parameters:

controlName - Control to move to.

Returns:

Void.

Class:

edmcommon.cmd.GotoControlFunction

gotoFirstRecord

Moves cursor to the first record on the active form.

Syntax:

gotoFirstRecord()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.GotoFirstRecordFunction

gotoFormControl

Moves cursor to a control.

Syntax:

gotoFormControl( 'formName', 'controlName')

Parameters:

formName - Form containing control to move to.

controlName - Control to move to.

Returns:

Void.

Class:

edmcommon.cmd.GotoFormControlFunction

gotoLastRecord

Moves cursor to the last record on the active form.

Syntax:

gotoLastRecord()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.GotoLastRecordFunction

gotoNewRecord

Moves cursor to the new empty record on the active form.

Syntax:

gotoNewRecord()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.GotoNewRecordFunction

gotoNextRecord

Moves cursor to the next record on the active form.

Syntax:

gotoNextRecord()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.GotoNextRecordFunction

gotoPrevRecord

Moves cursor to the previous record on the active form.

Syntax:

gotoPrevRecord()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.GotoPrevRecordFunction

gotoRecord

Moves cursor to a specific record on the active form.

Syntax:

gotoRecord( recordNumber)

Parameters:

recordNumber - Record number to go to.

Returns:

Void.

Class:

edmcommon.cmd.GotoRecordFunction

greatest

Returns the greater of two numbers

Syntax:

greatest( 'firstNumber', 'secondNumber')

Parameters:

firstNumber - First number to compare

secondNumber - Second number to compare

Returns:

Greater of two numbers

Class:

edmcommon.function.CommonFunctions

hasPermission

Returns true if the current user has the given permission type for the given object type and name.

Syntax:

hasPermission( 'permissionTypes', 'objectType', 'objectName')

Parameters:

permissionTypes - Comma-delimited list of permission types: VIEW, ADD, EDIT, DELETE, and/or EXECUTE.

objectType - Object type: function, data, company, etc.

objectName - Name of the object.

Returns:

Boolean.

Class:

edmclient.function.HasPermissionFunction

iif

Returns one of two values bases on expression

Syntax:

iif( 'expression', 'trueValue', 'falseValue')

Parameters:

expression - Expression to evaluate

trueValue - Value to return if the expression is TRUE

falseValue - Value to return if the expression is FALSE

Returns:

First value if expression is true, otherwise second value

Class:

edmcommon.function.CommonFunctions

importData

Imports a text file to a table.

Syntax:

importData( 'filename', HasNameRow, isDelimited, 'delimiter', 'columnLengths', 'dateFormat', 'tableName')

Parameters:

filename - Name of the text file to import.

HasNameRow - T/F does the first row of the text file contain column names?.

isDelimited - T/F is the text file delimited (as opposed to fixed length fields)?.

delimiter - Character that separates the fields (Comma, Tab, \ASCII code or character).

columnLengths - Length of each field separated by semicolons ';' for fixed length fields.

dateFormat - Format string that describes how dates appear in the text file.

tableName - Name of the table to which the data is to be added.

Returns:

Void.

Class:

edmclient.ClientFunctions

importFoodCostProducts

Import ascii file containing products for the food cost system.

Syntax:

importFoodCostProducts( 'siteId', 'fileName')

Parameters:

siteId - Id of the site to where data should be imported. If not a valid integer, user will be prompted to select a site.

fileName - Name of the ascii file to import. Null or blank means prompt user to enter file name.

Returns:

Void.

Class:

edmclient.plugin.UserClientPlugins

importSitesInFileList

Import sites listed in given siteIdFile from given company.

Syntax:

importSitesInFileList( 'fromCompanyName', 'siteIdFileName', 'transactionVersion', 'shareGroupId', 'shareTableList')

Parameters:

fromCompanyName - Name of company from which sites are imported.

siteIdFileName - Name of text file containing one or more rows of comm-delimited site IDs to import.

transactionVersion - Transaction version to use on imported live sites (version > 0), if blank leave unchanged.

shareGroupId - Id of share group whose tables are shared with all imported sites, null or blank means do not share.

shareTableList - Name of table list from snapshot.xml file with list of table shareGroup should share with imported site. Null or blank means do not share.

Returns:

Void.

Class:

edmcommon.cmd.ImportSitesInFileListCmd

importTableRelations

Import table relations from a text file

Syntax:

importTableRelations( 'filename')

Parameters:

filename - Name of text file to import

Returns:

Void.

Class:

edmcommon.cmd.ImportTableRelationsFunction

importTransactionsFromFile

Import transactions from a CSV file.

Syntax:

importTransactionsFromFile( 'filename')

Parameters:

filename - Name of the CSV file on the server containing transaction information.

Returns:

Void.

Class:

edmcommon.cmd.ImportTransactionsFromFileCmd

insertTableList

Insert a new table list.

Syntax:

insertTableList( tableList, index)

Parameters:

tableList - New table list to insert.

index - 0-based index where table list should be inserted among other table lists, if index is < 0 or >= list size, the new table list is added to the end of the list.

Returns:

Void.

Class:

edmcommon.cmd.EditSnapshotTablesCmd

isFormValueSelected

Gets whether or not a checkbox, radio button, or toggle button control is currently selected on a form with the given name.

Syntax:

isFormValueSelected( 'formName', 'controlName')

Parameters:

formName - Name of the form the control is on.

controlName - Name of checkbox, radio or toggle button control.

Returns:

True if the checkbox, radio button, or toggle button control is currently selected, otherwise false.

Class:

edmclient.function.ControlValueFunctions

isOnNewRow

True if the currently active form is on a new row, else False.

Syntax:

isOnNewRow()

Parameters:

none

Returns:

Boolean.

Class:

edmclient.function.IsOnNewRowFunction

isValueSelected

Gets whether or not a checkbox, radio button, or toggle button control is currently selected.

Syntax:

isValueSelected( 'controlName')

Parameters:

controlName - Name of checkbox, radio or toggle button control.

Returns:

True if the checkbox, radio button, or toggle button control is currently selected, otherwise false.

Class:

edmclient.function.ControlValueFunctions

least

Returns the lesser of two numbers

Syntax:

least( 'First number', 'Second number')

Parameters:

First number - First number to compare

Second number - Second number to compare

Returns:

Lesser of two numbers

Class:

edmcommon.function.CommonFunctions

left

Returns the leftmost characters of a string

Syntax:

left( 'String', Count)

Parameters:

String - String to get the characters from

Count - Number of characters to get

Returns:

Requested characters

Class:

edmcommon.function.CommonFunctions

len

Gets the length of a string

Syntax:

len( 'String')

Parameters:

String - String you want the length of

Returns:

Length of the string

Class:

edmcommon.function.CommonFunctions

loadAllTableData

Load data for the specified location from all tables in the table list

Syntax:

loadAllTableData( 'Location List')

Parameters:

Location List - List of comma-separated location id's of the locations whose data is to be deleted

Returns:

Void.

Class:

edmcommon.cmd.LoadAllTableDataCmd

loadCentralData

Load schema for a central database table

Syntax:

loadCentralData( 'tableNames', 'locationNumber', 'dataSourceName')

Parameters:

tableNames - Comma-separated list of table names whose data is to be loaded (blank means prompt user, * means all).

locationNumber - Location number of the location whose data is being loaded (blank means prompt user).

dataSourceName - Name of data source from which to load table data (blank means prompt user).

Returns:

Void.

Class:

edmcommon.cmd.LoadCentralDataPromptCmd

loadCentralSchema

Load schema for a central database table

Syntax:

loadCentralSchema( 'tableName', 'dataSourceName', 'tableVersion', 'override', 'ignoreInserts', 'ignoreUpdates', 'ignoreDeletes')

Parameters:

tableName - Name of table whose schema is to be loaded (blank to prompt user)

dataSourceName - Name of ODBC data source from which to load table schema (blank to prompt user)

tableVersion - Version number of table (blank to prompt user)

override - Flag for handling conflicts such as 'Log' or 'Undo' (blank to prompt user)

ignoreInserts - True if central database should not accept inserts from remote location (blank to prompt user).

ignoreUpdates - True if central database should not accept updates from remote location (blank to prompt user).

ignoreDeletes - True if central database should not accept deletes from remote location (blank to prompt user).

Returns:

Void.

Class:

edmcommon.cmd.AttachTableCmd

loadPicture

Loads a GIF, JPEG, or PNG image from the specified file

Syntax:

loadPicture( 'filename')

Parameters:

filename - Name of the GIF, JPEG, or PNG picture file to load

Returns:

String of hex digits representing the picture

Class:

edmcommon.cmd.LoadPictureFunction

login

Log a user into the system.

Syntax:

login( 'userid', 'password')

Parameters:

userid - Unique user id (blank means prompt user).

password - Password for the userid.

Returns:

Void.

Class:

edmcommon.cmd.LoginFunction

logout

Logs the current user out of the system.

Syntax:

logout()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.LogoutFunction

lower

Changes each letter of a string to lower case

Syntax:

lower( 'string')

Parameters:

string - String to convert

Returns:

String converted to lower case

Class:

edmcommon.function.CommonFunctions

maximizeContentArea

Maximizes the content area in the main EDM window.

Syntax:

maximizeContentArea()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.ToggleContentAreaSizeFunction

mod

Divides two values and returns the remainder

Syntax:

mod( 'firstValue', 'secondValue')

Parameters:

firstValue - Value to divide

secondValue - Value to divide by

Returns:

Remainder after division.

Class:

edmcommon.function.CommonFunctions

month

Returns the month value of a date

Syntax:

month( 'date')

Parameters:

date - Date to get the month from (local-specific format)

Returns:

Month number (1-12)

Class:

edmcommon.function.CommonFunctions

moveTransactions

Moves transactions for the specified locations from the local send directory to the specified directory.

Syntax:

moveTransactions( 'locationIdList', 'toDirectory')

Parameters:

locationIdList - Comma-separated list of locations whose transactions are to be moved (blank means prompt user).

toDirectory - Directory to which transactions should be moved (blank means prompt user).

Returns:

Void.

Class:

edmclient.plugin.UserClientPlugins

msg

Displays a message box.

Syntax:

msg( 'text', 'title', flags)

Parameters:

text - Message text.

title - Message dialog title.

flags - Sum of button codes to display (Ok=1, Yes=2, Cancel=4, No=8).

Returns:

Value of button user selected to close message box.

Class:

edmcommon.cmd.MsgFunction

notifyClients

Send a notification to connected clients.

Syntax:

notifyClients( 'title', 'message', 'delayMinutes')

Parameters:

title - Title of message to display to client (blank or ? means prompt user).

message - Message to display to client (blank or ? means prompt user).

delayMinutes - How many minutes to delay before sending message to connected clients.

Returns:

Void.

Class:

edmcommon.cmd.NotifyClientsCmd

nullValue

Return a null value which can be used in other functions. If you want to set the value of a form control to null, use setFormValueToNull() or setValueToNull().

Syntax:

nullValue()

Parameters:

none

Returns:

Null.

Class:

edmcommon.function.NullValueFunction

numberToDate

Converts a number to a date

Syntax:

numberToDate( 'number')

Parameters:

number - Number to convert

Returns:

Date value

Class:

edmcommon.function.CommonFunctions

numberToInt

Returns the integer part of a number string.

Syntax:

numberToInt( 'number')

Parameters:

number - Number string to convert

Returns:

Ingteger value.

Class:

edmcommon.function.CommonFunctions

numberToString

Converts a number to a string

Syntax:

numberToString( 'number', 'Format')

Parameters:

number - Number to convert

Format - Format string to use

Returns:

String representation of the number

Class:

edmcommon.function.CommonFunctions

numberToTime

Converts a number to a time

Syntax:

numberToTime( 'number')

Parameters:

number - Number to convert

Returns:

Time value

Class:

edmcommon.function.CommonFunctions

numberToTimestamp

Converts a number to a timestamp

Syntax:

numberToTimestamp( 'number')

Parameters:

number - Number to convert

Returns:

Timestamp value

Class:

edmcommon.function.CommonFunctions

open

Opens an object.

Syntax:

open( 'objectType', 'objectName')

Parameters:

objectType - Type of object (table, query, form, or function).

objectName - Name of the object.

Returns:

Void.

Class:

edmcommon.cmd.GetOpenFormCmd

openForm

Ask server to open a form. All parameters must be complete, user will be prompted for routing information if necessary.

Syntax:

openForm( 'name', 'view', visible)

Parameters:

name - Name of form.

view - View to display, 'SINGLE' (form view), 'GRID' (spreadsheet view) or '' (default view).

visible - True if form is visible after opening, otherwise false.

Returns:

Void.

Class:

edmcommon.cmd.GetOpenFormCmd

openRowSetForm

Open form to edit row sets to restrict which table rows and columns users may edit.

Syntax:

openRowSetForm()

Parameters:

none

Returns:

Void.

Class:

edmclient.function.OpenRowSetFormFunction

openSitePropertyValueEditor

Open the Site Property Values form.

Syntax:

openSitePropertyValueEditor()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.OpenSitePropertyValueEditorFunction

partitionTable

Partition a table and set a new partition expression and reorganize the rows into the correct partitions.

The audit table can now be partitioned across multiple database servers which process queries in parallel for much faster performance. Transaction records are divided among the partitions based on a partitioning expression. Queries on the audit table are sent to each partition server for parallel processing and the results are merged by EDM so that the partitioning is transparent to EDM users.The primary partition will continue to reside in the EDM central database, additional partitions can be stored on other servers.

To partition the audit table into three parts take the following steps:

• Backup your central database and the web application folder (webapps/edm)
• Add new data sources named 'Partition2' and 'Partition3' to the config.xml with the connection information to the new partition servers.
• Restart the web server or reload the cached data so the server will recognize the new data sources.
• Add a menu option with the action: PartitionTable( 'CDMAudit', 'Partition2,Partition3', 'iif( FromLoc = 0, ToLoc % 3, FromLoc % 3 )' )
• Click on the new menu option and watch the progress of the partitioning on the status bar.

After partitioning the audit table, if you have regular backups of your system database, you should include the new partition databases in your backup schedule.

Syntax:

partitionTable( 'tableName', 'partitionDataSourceNames', 'partitionExpression')

Parameters:

tableName - Name of the table which is to have a new partition added.

partitionDataSourceNames - Comma-delimited list of data source names where the table partitions are to be created.

partitionExpression - Expression used to determine which partition a row is in by calculating a number between 0 and the number of partition data source names. For example, if you specify 1 partition data source name 'Part1' and want rows with even CDMLOCID's in the primary table and rows with odd CDMLOCID's in the partition then the expression would be 'CDMLOCID % 2' which will return 0 for even CDMLOCID's and 1 for odd CDMLOCID's. If the expression returns a number higher than the number of partition data sources for a row, then the row will be in the main table.

Returns:

null

Class:

edmcommon.cmd.PartitionTableCmd

paste

Pastes an object from the clipboard.

Syntax:

paste( 'objectType', 'objectName')

Parameters:

objectType - Type of object (table, query, form, report or function).

objectName - Name of the object.

Returns:

Void.

Class:

edmcommon.cmd.PasteFunction

playbackTestScript

Play a test script back.

Syntax:

playbackTestScript( 'name', 'serverURL', concurrentUsers, secondsBetweenStarts)

Parameters:

name - Name of the test script directory.

serverURL - URL of the server where commands are sent.

concurrentUsers - Number of concurrent instances of the test to run.

secondsBetweenStarts - Number of seconds between starting each concurrent test instance.

Returns:

Void.

Class:

edmcommon.cmd.PlaybackTestScriptFunction

pow

Raises a number to a power

Syntax:

pow( 'number', power)

Parameters:

number - Number to raise to a power

power - Power to raise the number to

Returns:

Number raised to a power

Class:

edmcommon.function.CommonFunctions

processForcedTransactions

Receive and apply pending transactions whose effective date has arrived and whose Force flag is true for all sites.

Syntax:

processForcedTransactions()

Parameters:

none

Returns:

Void.

Class:

edmclient.function.ProcessForcedTransactionsFunction

processTransactions

Receive and apply pending transactions from selected locations whose effective date has arrived

Syntax:

processTransactions( 'locations')

Parameters:

locations - Comma-separated list of location id numbers (blank means prompt user, * means all locations).

Returns:

Void.

Class:

edmcommon.cmd.ProcessTransactionsCmd

promptForTransactionReport

Display dialog for users to set filters and run transaction report.

Syntax:

promptForTransactionReport()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.CreateTransactionReportCmd

publishMasterDataTableList

Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Data is published for each site in share groups using the site’s real ID.

Syntax:

publishMasterDataTableList( 'tableListName', 'siteIdList', 'directory')

Parameters:

tableListName - Name of table list from snapshot file. (blank means prompt user to select).

siteIdList - Comma-separated list of site IDs (null, '', or '?' means prompt user to select, '*' means all).

directory - Directory where published data files are to be stored.

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.PublishMasterDataCmd

publishMasterDataTables

Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Data is published for each site in share groups using the site’s real ID.

Syntax:

publishMasterDataTables( 'tableNameList', 'siteIdList', 'directory')

Parameters:

tableNameList - Comma-separated list of table names to publish (blank means prompt user to select, '*' means all).

siteIdList - Comma-separated list of site IDs (null, '', or '?' means prompt user to select, '*' means all).

directory - Directory where published data files are to be stored.

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.PublishMasterDataCmd

publishXCEDataTableList

Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Share groups are included in the published data with the associated data site IDs.

Syntax:

publishXCEDataTableList( 'tableListName', 'siteIdList', 'directory')

Parameters:

tableListName - Name of table list from snapshot file. (blank means prompt user to select).

siteIdList - Comma-separated list of site IDs (null, '', or '?' means prompt user to select, '*' means all).

directory - Directory where published data files are to be stored.

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.PublishXCEDataCmd

publishXCEDataTables

Publish data from the central database, with open and future transactions rolled back, to .csv files in the given directory. Share groups are included in the published data with the associated data site IDs.

Syntax:

publishXCEDataTables( 'tableNameList', 'siteIdList', 'directory')

Parameters:

tableNameList - Comma-separated list of table names to publish (blank means prompt user to select, '*' means all).

siteIdList - Comma-separated list of site IDs (null, '', or '?' means prompt user to select, '*' means all).

directory - Directory where published data files are to be stored.

Returns:

Void.

Class:

edmclient.plugin.mdm.cmd.PublishXCEDataCmd

queryAvg

Gets the average of the values of a column in a table or query using a where clause.

Syntax:

queryAvg( 'column', 'table', 'where')

Parameters:

column - Name of the column to get.

table - Name of the table containing the column.

where - Where clause to filter the rows in the table.

Returns:

Value of field if successful, otherwise empty string.

Class:

edmcommon.cmd.QueryValueCmd

queryCount

Gets the count of the values of a column in a table or query using a where clause.

Syntax:

queryCount( 'column', 'table', 'where')

Parameters:

column - Name of the column to get.

table - Name of the table containing the column.

where - Where clause to filter the rows in the table.

Returns:

Value of field if successful, otherwise empty string.

Class:

edmcommon.cmd.QueryValueCmd

queryFirst

Gets the first value of a column in a table or query using a where clause.

Syntax:

queryFirst( 'column', 'table', 'where')

Parameters:

column - Name of the column to get.

table - Name of the table containing the column.

where - Where clause to filter the rows in the table.

Returns:

Value of field if successful, otherwise empty string.

Class:

edmcommon.cmd.QueryValueCmd

queryLast

Gets the last value of a column in a table or query using a where clause.

Syntax:

queryLast( 'column', 'table', 'where')

Parameters:

column - Name of the column to get.

table - Name of the table containing the column.

where - Where clause to filter the rows in the table.

Returns:

Value of field if successful, otherwise empty string.

Class:

edmcommon.cmd.QueryValueCmd

queryMax

Gets the maximum value of a column in a table or query using a where clause.

Syntax:

queryMax( 'column', 'table', 'where')

Parameters:

column - Name of the column to get.

table - Name of the table containing the column.

where - Where clause to filter the rows in the table.

Returns:

Value of field if successful, otherwise empty string.

Class:

edmcommon.cmd.QueryValueCmd

queryMin

Gets the minimum value of a column in a table or query using a where clause.

Syntax:

queryMin( 'column', 'table', 'where')

Parameters:

column - Name of the column to get.

table - Name of the table containing the column.

where - Where clause to filter the rows in the table.

Returns:

Value of field if successful, otherwise empty string.

Class:

edmcommon.cmd.QueryValueCmd

querySum

Gets the sum of the values of a column in a table or query using a where clause.

Syntax:

querySum( 'column', 'table', 'where')

Parameters:

column - Name of the column to get.

table - Name of the table containing the column.

where - Where clause to filter the rows in the table.

Returns:

Value of field if successful, otherwise empty string.

Class:

edmcommon.cmd.QueryValueCmd

queryValue

Directly execute an SQL statement and return the value of the first column in the first row. If query is not a select statement, execute the SQL statement and return a blank string. Use caution to avoid exceeding available memory.

Syntax:

queryValue( 'dataSourceName', 'sql')

Parameters:

dataSourceName - Name of the EDM data source where the query is to execute.

sql - SQL statement to execute.

Returns:

String

Class:

edmcommon.cmd.ExecuteQueryCmd

random

Returns a random number between 0 and the passed number

Syntax:

random( max)

Parameters:

max - Maximum random number that can be returned

Returns:

Random number

Class:

edmcommon.function.CommonFunctions

receiveSiteFilesViaWeb

Receive transaction files over HTTP web connection.

Syntax:

receiveSiteFilesViaWeb( 'siteIdList')

Parameters:

siteIdList - Comma-separated list of sites id's to transfer (blank to prompt user, * for all sites).

Returns:

Void.

Class:

edmcommon.cmd.TransferFilesCmd

receiveTransactionFilesFromAmazon

Receive transaction files from Amazon Simple Storage Service (S3).

Syntax:

receiveTransactionFilesFromAmazon( 'siteIdList', 'bucketName', 'prefix', 'encryptedCredentials')

Parameters:

siteIdList - Comma-separated list of site IDs to receive (blank to prompt user, * for all locations).

bucketName - Name of Amazon S3 bucket containing incoming and outgoing folders.

prefix - Common prefix of all transaction file names to be transferred without the site ID path segment, e.g. "outgoing/".

encryptedCredentials - AWS credentials encrypted with the EncryptAmazonCredentialsCmd object.

Returns:

Void

Class:

edmcommon.cmd.ReceiveTransactionFilesFromAmazonCmd

receiveTransactionFilesFromJMS

Receive files from the configured JMS queue into the local incoming folder.

Syntax:

receiveTransactionFilesFromJMS( 'siteIdList', 'queueName', 'brokerURL', 'userId', 'password')

Parameters:

siteIdList - Comma-separated list of site IDs to receive (blank to prompt user, * for all locations).

queueName - Name of the queue from which incoming transaction files should be received. For example: edm.incoming.%REMOTESITEID%

brokerURL - URL used to connect to the JMS broker. For example: tcp://localhost:61616

userId - User ID used to connect to the JMS broker.

password - Password used to connect to the JMS broker.

Returns:

Void

Class:

edmcommon.cmd.ReceiveTransactionFilesFromJMSCmd

reloadCachedData

Reload cached data such as configuration, site list, etc.

Syntax:

reloadCachedData()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.ReloadCachedDataCmd

rename

Renames an object to a new name.

Syntax:

rename( 'objectType', 'objectName', 'newName')

Parameters:

objectType - Type of object (table, query, form, report or function).

objectName - Name of the object (case-insensitive).

newName - New name of the object (blank means prompt user).

Returns:

Void.

Class:

edmcommon.cmd.RenameFunction

replaceAll

Replaces each substring of this string that matches the given regular expression with the given replacement.

Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string.

Syntax:

replaceAll( 'string', 'regularExpression', 'replacement')

Parameters:

string - String to which replacements are made.

regularExpression - Regular expression to which this string is to be matched.

replacement - String to be substituted for each match

Returns:

String with each match replaced with the replacement string or null if the given string is null.

Class:

edmcommon.function.CommonFunctions

replaceTransWithRefresh

Replaces transaction files for the selected locations with a refresh table transaction using the specified snapshot.

Syntax:

replaceTransWithRefresh( 'locationIdList', 'snapshotName')

Parameters:

locationIdList - Comma-separated list of locations whose transactions are to be moved (blank means prompt user).

snapshotName - Name of snapshot to use for table refresh (blank means prompt user).

Returns:

Void.

Class:

edmclient.plugin.UserClientPlugins

requery

Requeries the records on the active form.

Syntax:

requery()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.RequeryFunction

requeryControl

Requeries the records of the control's source on the active form.

Syntax:

requeryControl( 'controlName')

Parameters:

controlName - Control to requery.

Returns:

Void.

Class:

edmcommon.cmd.RequeryControlFunction

requestDatedTableRefresh

Send request to location to send table data to replace existing data

Syntax:

requestDatedTableRefresh( 'snapshotName', 'selectedLocations', forceProcessing, 'packageName', 'packageDescription', 'rollbackType', 'rollbackDate', 'rollbackTime')

Parameters:

snapshotName - Name of the snapshot containing the list of tables to refresh (blank means prompt user to select).

selectedLocations - List of comma-separated location ID's of the locations from which to get the test records (blank means prompt user to select).

forceProcessing - True if transactions should be processed when only processing forced transactions.

packageName - Name of package to hold transactions (blank means prompt user to select).

packageDescription - Description of package if a new package is to be created

rollbackType - Type of transaction roll back: 'NONE', 'NOW', or 'SPECIFIED'. Prompt user if blank.

rollbackDate - If rollbackType is 'SPECIFIED', date to which transactions should be rolled back, format is mm/dd/yyyy.

rollbackTime - If rollbackType is 'SPECIFIED', time to which transactions should be rolled back, format is hh:mm:ss.SSS AM.

Returns:

Void.

Class:

edmcommon.cmd.TableRefreshCmd

requestFile

Copy a file to other locations

Syntax:

requestFile( 'locationList', 'fromFile', 'toFile', flags, 'effectiveDate', 'packageName', 'packageDescription')

Parameters:

locationList - Comma-separated list of location numbers from which to request file (blank means prompt user, * means all locations).

fromFile - Full path of file to copy (if blank, prompt user to select)

toFile - Full path of destination file at other locations (if blank, prompt user to select)

flags - 1 if file should be overwritten if it exists at destination location; 2 if file should be kept synchronized after being sent.

effectiveDate - Date file should be copied to destination

packageName - Name of package to hold transactions

packageDescription - Description of package if new package.

Returns:

Void.

Class:

edmcommon.cmd.WriteFileTransactionCmd

requestTableRefresh

Send request to location to send table data to replace existing data

Syntax:

requestTableRefresh( 'snapshotName', 'selectedLocations', 'packageName', 'packageDescription')

Parameters:

snapshotName - Name of the snapshot containing the list of tables to refresh (blank means prompt user to select).

selectedLocations - List of comma-separated location ID's of the locations from which to get the test records (blank means prompt user to select).

packageName - Name of package to hold transactions (blank means prompt user to select).

packageDescription - Description of package if a new package is to be created

Returns:

Void.

Class:

edmcommon.cmd.TableRefreshCmd

resetSite

Deprecated - use resetSites instead. Send Reset transaction to reset a site to its newly installed state.

Syntax:

resetSite( 'siteList', 'packageName', 'packageDescription')

Parameters:

siteList - Comma-separated list of site IDs to reset.

packageName - Package name to use for transactions.

packageDescription - Package description if creating new package.

Returns:

void

Class:

edmcommon.cmd.ResetSitesCmd

resetSites

Send transactions to reset remote sites to their newly installed state and commit the transactions.

Syntax:

resetSites( 'siteIdList')

Parameters:

siteIdList - Comma-separated list of site IDs to reset.

Returns:

void

Class:

edmcommon.cmd.ResetSitesCmd

restoreContentArea

Restores the content area in the main EDM window.

Syntax:

restoreContentArea()

Parameters:

none

Returns:

Void.

Class:

edmcommon.cmd.ToggleContentAreaSizeFunction

restoreTestCheckpoint

Disconnect all database connections, restore checkpoint 1, and re-initialize server

Syntax:

restoreTestCheckpoint( 'checkPoint', 'batchFile')

Parameters:

checkPoint - Checkpoint to restore.

batchFile - Batch file that restores test checkpoint.

Returns:

Void

Class:

edmcommon.cmd.RestoreTestCheckpointCmd

retryTest

Retry a test that failed during runTest.

Syntax:

retryTest( 'testListClassName', 'testClassName', 'firstTestMethodToCall', exitAfterTest)

Parameters:

testListClassName - Name of class that hold the list of test classes.

testClassName - Test class name.

firstTestMethodToCall - First test method in the class to call, null or blank means call all test methods.

exitAfterTest - True if program should exit when test is complete.

Returns:

Void.

Class:

edmclient.function.RunTestFunction

right

Returns the rightmost characters of a string

Syntax:

right( 'string', Count)

Parameters:

string - String to get the characters from

Count - Number of characters to get

Returns:

Requested characters

Class:

edmcommon.function.CommonFunctions

round

Rounds a number at the specified number of digits past the decimal

Syntax:

round( 'number', digits)

Parameters:

number - Number to round

digits - Number of digits past the decimal to keep

Returns:

Rounded number

Class:

edmcommon.function.CommonFunctions

runApp

Runs an application as if from the command line. For example, to open the config.xml file in notepad when transactions are processed, set the filespec to c:\windows\system32\notepad.exe, the arguments to c:\edmweb\config.xml, and the wait flag to false. To run a batch file you could set the filespec to cmd and the arguments to /c c:\edmweb\go.bat and the wait flag to false.

Syntax:

runApp( 'filespec', 'arguments', wait)

Parameters:

filespec - Path and filename of application.

arguments - Parameters to pass to the application.

wait - Wait for application to complete before returning.

Returns:

0 if successful, otherwise error code.

Class:

edmcommon.cmd.RunAppCmd

runJUnitTest

Run the JUnit tests in the given class.

Syntax:

runJUnitTest( 'jUnitClassName')

Parameters:

jUnitClassName - JUnit test class to run.

Returns:

Void.

Class:

edmcommon.cmd.RunJUnitTestCmd

runPriceChangeByPriceGroupReport

Run price change by price group report with user-specified filters and sorting.

Syntax:

runPriceChangeByPriceGroupReport()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.iris.CreateTransactionReportForIrisPricesByPriceGroupCmd

runPriceChangeByPriceReport

Run price change by price report with user-specified filters and sorting.

Syntax:

runPriceChangeByPriceReport()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.iris.CreateTransactionReportForIrisPricesByPriceCmd

runPriceChangeReport

Run price report with user-specified filters and sorting.

Syntax:

runPriceChangeReport()

Parameters:

none

Returns:

Void.

Class:

edmclient.plugin.iris.CreateTransactionReportForIrisPricesCmd

runReport

Run a report.

Syntax:

runReport( 'configFileName', 'outputType')

Parameters:

configFileName - Path and file name of file containing report settings.)

outputType - Type of report output file. Supported types are 'PDF', 'HTML', and 'XML'.

Returns:

Void.

Class:

edmcommon.cmd.RunReportCmd

runSQL

Runs an SQL statement.

Syntax:

runSQL( 'sql')

Parameters:

sql - SQL statement to run.

Returns:

Void.

Class:

edmcommon.cmd.RunSQLFunction