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.
addAmazonCommitListener	Add listener that sends outgoing transaction files for selected sites to Amazon as soon as they are committed.
addDeleteAmazonTransactionsOnResetListener	Add listener that deletes transaction files from the Amazon incoming and outgoing directory when a reset site transaction is committed.
addJMSCommitListener	Add listener that sends outgoing transaction files for selected sites to a JMS queue as soon as they are committed.
addJMSReceiveListener	Add listener that receives transaction file messages from a JMS queue and writes them to the incoming directory.
addJMSReceiveListenerWithRetry	Add listener that receives transaction file messages from a JMS queue and writes them to the incoming directory.
addProcessReceivedTransactionsListener	Add listener that automatically processes incoming transactions as soon as they are received.
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.
addTransactionsProcessedListener	Add listener that evaluates the given expression whenever transaction processing completes.
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.
changePackageStatus	Change status of the transactions for sites in a package to a new status.
changePassword	Change the current user's password.
commitTransactions	Commit packages of transactions so they are sent to selected locations
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.
copySiteData	Copy data for selected tables from one location to another location
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.
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.
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.
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.
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.
exportData	Exports data from a table or query to a text file.
exportSecurityPolicyToXml	Export users, roles, and other security settings to XML file.
exportSelectedDataToFile	Export data to a file from a table
fileExists	Returns true if the given file or directory exists.
generateFunctionHelp	Generate HTML help file for a list of PluginLoader classes.
getAppObject	Returns application object with specified type and name or null if not found.
getConfigProperty	Get configuration property value.
getConfigPropertyWithDefault	Get configuration property value.
getIniValue	Returns value for the given key from the given ini file or null if not found.
getMasterTableConfigurationType	Gets the Configuration Type for the given table with the given name.
getNextUnusedId	Gets the next unused ID for the given table and column, optionally within a range.
getPropertyFileValue	Get the value of a property in a property file.
getRegistryValue	Returns the value from the Windows registry for the given key, value, and substring.
getReportConfig	Return the ReportConfig stored in the given file.
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.
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.
getUnlockedPackageVersions	Get a ValueList of version ids and names that are not referenced by unlocked packages.
getValueListOfUsersWithRole	Get a value list of users with a given role separated by semicolons.
getVersion	Return the current version of EDM
greatest	Returns the greater of two numbers
iif	Returns one of two values bases on expression
importData	Imports a text file to a table.
importFile	Imports a text file to a table.
importTransactionsFromFile	Import transactions from a CSV file.
insertTableList	Insert a new table list.
least	Returns the lesser of two numbers
left	Returns the leftmost characters of a string
len	Gets the length of a string
loadCentralData	Load schema for a central database table
loadCentralSchema	Load schema for a central database table
lower	Changes each letter of a string to lower case
mod	Divides two values and returns the remainder
month	Returns the month value of a date
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
partitionTable	Partition a table and set a new partition expression and reorganize the rows into the correct partitions.
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 sites whose effective date has arrived
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.
purgeAuditTrail	Delete audit trail rows that are older than the given number of days.
purgePollData	Delete polled table rows that are older than the given number of days.
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.
random	Returns a random number between 0 and the passed number
receiveSiteFilesViaWeb	Receive transaction files over HTTP 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 all data cached in server memory on the server and re-initialize system.
removeAmazonCommitListener	Reomve listener that sends outgoing transaction files for selected sites to Amazon as soon as they are committed.
removeTransactionsProcessedListener	Remove listener that evaluates the given expression whenever transaction processing completes.
replaceAll	Replaces each substring of this string that matches the given regular expression with the given replacement.
requestFile	Copy a file to other locations
requestTableListRefresh	Send request to location to send table data to replace existing data
requestTableRefresh	Send request to location to send table data to replace existing data
resetSites	Send transactions to reset remote sites to their newly installed state and commit the transactions.
restoreTestCheckpoint	Disconnect all database connections, restore checkpoint 1, and re-initialize server.
right	Returns the rightmost characters of a string
round	Rounds a number at the specified number of digits past the decimal
runApp	Execute the given command line. For example, to open the config.xml file in notepad execute the command `c:\windows\system32\notepad.exe c:\edmweb\config.xml`, and the wait flag to `false`. To run a batch file you could execute the command `cmd /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	Executes an insert, update, delete, or maketable SQL statement.
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
sendRemoteFiles	Send files listed in remote files table to sites.
sendSiteFilesViaWeb	Send transaction files over HTTP connection.
sendSynchronizeDirectoryTransaction	Send a transaction to synchronize a local directory with a directory at other sites.
sendTableListRefresh	Send table data to locations to replace existing data
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.
sendTransactionFilesToJMSWithRetry	Send outgoing files for the given sites to a JMS queue. If the transfer fails due to a JMS error, the listener will retry after 15 seconds, 30 seconds, then 1 minute, 2 minutes, 4 minutes, 8 minutes, then every 15 minutes until the transfer works.
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.
space	Creates a string of blanks
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
transferSiteFilesViaFTP	Transfer transaction files over FTP connection.
transferSiteFilesViaRAS	Transfer transaction files over network connection.
transferSiteFilesViaWeb	Transfer transaction files over HTTP 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
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.
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
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...
delete	Deletes an object.
deleteTable	Deletes a table.
getAppObject	Returns application object with specified type and name or null if not found.

Record Functions

Function	What it does...

Form Functions

Function	What it does...

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.
deleteTableList	Delete a table list.
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.
exportData	Exports data from a table or query to a text file.
exportSecurityPolicyToXml	Export users, roles, and other security settings to XML file.
getIniValue	Returns value for the given key from the given ini file or null if not found.
getRegistryValue	Returns the value from the Windows registry for the given key, value, and substring.
getReportConfig	Return the ReportConfig stored in the given file.
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.
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.
iif	Returns one of two values bases on expression
importData	Imports a text file to a table.
importFile	Imports a text file to a table.
importTransactionsFromFile	Import transactions from a CSV file.
insertTableList	Insert a new table list.
partitionTable	Partition a table and set a new partition expression and reorganize the rows into the correct partitions.
runApp	Execute the given command line. For example, to open the config.xml file in notepad execute the command `c:\windows\system32\notepad.exe c:\edmweb\config.xml`, and the wait flag to `false`. To run a batch file you could execute the command `cmd /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	Executes an insert, update, delete, or maketable SQL statement.
updateTableList	Update a table list.

Enterprise Data Manager Functions

Function	What it does...
addAmazonCommitListener	Add listener that sends outgoing transaction files for selected sites to Amazon as soon as they are committed.
addDeleteAmazonTransactionsOnResetListener	Add listener that deletes transaction files from the Amazon incoming and outgoing directory when a reset site transaction is committed.
addJMSCommitListener	Add listener that sends outgoing transaction files for selected sites to a JMS queue as soon as they are committed.
addJMSReceiveListener	Add listener that receives transaction file messages from a JMS queue and writes them to the incoming directory.
addJMSReceiveListenerWithRetry	Add listener that receives transaction file messages from a JMS queue and writes them to the incoming directory.
addProcessReceivedTransactionsListener	Add listener that automatically processes incoming transactions as soon as they are received.
addTransactionsProcessedListener	Add listener that evaluates the given expression whenever transaction processing completes.
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.
commitTransactions	Commit packages of transactions so they are sent to selected locations
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.
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.
deleteTransactionFilesFromAmazon	Delete transaction files (.xml and .fil) from the Amazon Simple Storage Service (S3).
exportSelectedDataToFile	Export data to a file from a table
fileExists	Returns true if the given file or directory exists.
generateFunctionHelp	Generate HTML help file for a list of PluginLoader classes.
getConfigProperty	Get configuration property value.
getConfigPropertyWithDefault	Get configuration property value.
getNextUnusedId	Gets the next unused ID for the given table and column, optionally within a range.
getPropertyFileValue	Get the value of a property in a property file.
getValueListOfUsersWithRole	Get a value list of users with a given role separated by semicolons.
loadCentralData	Load schema for a central database table
loadCentralSchema	Load schema for a central database table
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().
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 sites whose effective date has arrived
purgeAuditTrail	Delete audit trail rows that are older than the given number of days.
purgePollData	Delete polled table rows that are older than the given number of days.
receiveSiteFilesViaWeb	Receive transaction files over HTTP 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 all data cached in server memory on the server and re-initialize system.
removeAmazonCommitListener	Reomve listener that sends outgoing transaction files for selected sites to Amazon as soon as they are committed.
removeTransactionsProcessedListener	Remove listener that evaluates the given expression whenever transaction processing completes.
requestFile	Copy a file to other locations
requestTableListRefresh	Send request to location to send table data to replace existing data
requestTableRefresh	Send request to location to send table data to replace existing data
resetSites	Send transactions to reset remote sites to their newly installed state and commit the transactions.
restoreTestCheckpoint	Disconnect all database connections, restore checkpoint 1, and re-initialize server.
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
sendRemoteFiles	Send files listed in remote files table to sites.
sendSiteFilesViaWeb	Send transaction files over HTTP connection.
sendSynchronizeDirectoryTransaction	Send a transaction to synchronize a local directory with a directory at other sites.
sendTableListRefresh	Send table data to locations to replace existing data
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.
sendTransactionFilesToJMSWithRetry	Send outgoing files for the given sites to a JMS queue. If the transfer fails due to a JMS error, the listener will retry after 15 seconds, 30 seconds, then 1 minute, 2 minutes, 4 minutes, 8 minutes, then every 15 minutes until the transfer works.
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.
synchronizeSitePropertyValues	Imort and sync the site property values from an outside data source
transferSiteFilesViaFTP	Transfer transaction files over FTP connection.
transferSiteFilesViaRAS	Transfer transaction files over network connection.
transferSiteFilesViaWeb	Transfer transaction files over HTTP connection.
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.
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

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.
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.
deployMasterChanges	Deploy master data to application tables in the table map.
getMasterTableConfigurationType	Gets the Configuration Type for the given table with the given name.
getUnlockedPackageVersions	Get a ValueList of version ids and names that are not referenced by unlocked packages.
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.

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

addAmazonCommitListener

Add listener that sends outgoing transaction files for selected sites to Amazon as soon as they are committed.

Syntax:: addAmazonCommitListener( 'siteIdList', 'bucketName', 'prefix', 'encryptedCredentials')
Parameters:: siteIdList - Comma-separated list of site id numbers (* means all sites).; bucketName - Name of Amazon S3 bucket containing incoming and outgoing directories.; 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:: edmserver.function.AddAmazonCommitListenerFunction

addDeleteAmazonTransactionsOnResetListener

Add listener that deletes transaction files from the Amazon incoming and outgoing directory when a reset site transaction is committed.

Syntax:: addDeleteAmazonTransactionsOnResetListener( 'siteIdList', 'bucketName', 'incomingPrefix', 'outgoingPrefix', 'encryptedCredentials')
Parameters:: siteIdList - Comma-separated list of site IDs whose Amazon files will be deleted if they are reset. (blank to prompt user, * for all sites).; bucketName - Name of Amazon S3 bucket containing incoming and outgoing folders.; incomingPrefix - Prefix of all incoming transaction file names to be deleted without the site ID path segment, e.g. "incoming/".; outgoingPrefix - Prefix of all outgoing 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:: edmserver.function.AddDeleteAmazonTransOnResetListenerFunction

addJMSCommitListener

Add listener that sends outgoing transaction files for selected sites to a JMS queue as soon as they are committed.

Syntax:: addJMSCommitListener( 'siteIdList', 'queueName', 'brokerURL', 'userId', 'password')
Parameters:: siteIdList - Comma-separated list of site id numbers (* means all sites).; queueName - Name of the queue where outgoing transaction files should be sent. For example: edm.outgoing.%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:: edmserver.function.AddJMSCommitListenerFunction

addJMSReceiveListener

Add listener that receives transaction file messages from a JMS queue and writes them to the incoming directory.

Syntax:: addJMSReceiveListener( 'queueName', 'brokerURL', 'userId', 'password')
Parameters:: queueName - Name of the queue where incoming transaction files are received. For example: edm.incoming; 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:: edmserver.function.AddJMSReceiveListener

addJMSReceiveListenerWithRetry

Add listener that receives transaction file messages from a JMS queue and writes them to the incoming directory.

Syntax:: addJMSReceiveListenerWithRetry( 'queueName', 'brokerURL', 'userId', 'password', retrySeconds)
Parameters:: queueName - Name of the queue where incoming transaction files are received. For example: edm.incoming; 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.; retrySeconds - Number of seconds we waited before previous retry if the call fails. 0 means this is the first retry.
Returns:: Void.
Class:: edmserver.function.AddJMSReceiveListener

addProcessReceivedTransactionsListener

Add listener that automatically processes incoming transactions as soon as they are received.

Syntax:: addProcessReceivedTransactionsListener()
Parameters:: none
Returns:: Void.
Class:: edmserver.function.AddProcessReceivedTransactionsListenerFunction

addRow

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

afterInsert

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:: edmserver.cmd.AddRowCmdExecutor

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:: edmserver.cmd.AddSystemEventListenerCmdExecutor

addThisSiteToCentral

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

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:: edmserver.cmd.AddThisSiteToCentralCmdExecutor

addTransactionsProcessedListener

Add listener that evaluates the given expression whenever transaction processing completes.

Syntax:: addTransactionsProcessedListener( 'expression')
Parameters:: expression - Expression to evaluate after transaction processing completes.
Returns:: Void.
Class:: edmserver.function.AddTransactionsProcessedListenerFunction

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:: edmserver.plugin.mdm.cmd.ApplyEffectiveMasterDataTransCmdExecutor

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

Syntax:: attachMasterTables( 'tableNames', 'dataSourceName')
Parameters:: tableNames - Comma-delimited list of table names to attach.; dataSourceName - Name of the data source in the configuration that contains the tables.
Returns:: Void.
Class:: edmserver.plugin.mdm.cmd.AttachMasterTablesCmdExecutor

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.; dataSourceName - Name of data source from which to attach the table.; tableVersion - Version number of table to be attached.; ignoreInserts - True if central database should not accept inserts from remote location.; ignoreUpdates - True if central database should not accept updates from remote location.; ignoreDeletes - True if central database should not accept deletes from remote location.
Returns:: Void.
Class:: edmserver.cmd.AttachTableCmdExecutor

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.; dataSourceName - Name of data source from which to attach the tables.
Returns:: Void.
Class:: edmserver.cmd.AttachTableCmdExecutor

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:: String
Class:: edmserver.cmd.CallEvaluateExpressionWebMethodCmdExecutor

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:: edmserver.cmd.ChangePackageStatusCmdExecutor

changePassword

Change the current user's password.

Syntax:: changePassword( 'oldPassword', 'newPassword')
Parameters:: oldPassword - Current user's password encrypted and converted to string of hex digits.; newPassword - New password encrypted and converted to string of hex digits.
Returns:: Void.
Class:: edmserver.cmd.ChangePasswordCmdExecutor

commitTransactions

Commit packages of transactions so they are sent to selected locations

Syntax:: commitTransactions( 'packageNameList', 'locationIdList')
Parameters:: packageNameList - Semicolon separated list of package names to commit. * means all sites.; locationIdList - Semicolon separated list of location numbers to commit packages. * means all packages.
Returns:: Void.
Class:: edmserver.cmd.CommitCmdExecutor

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', 'toLocations', 'tableList', overwrite, copySharing, 'effectiveDate', forceProcessing, autoCommit)
Parameters:: fromSiteId - Site id to copy from.; toLocations - Comma-separated list of site IDs to copy to.; tableList - Name of a table list or a comma-separated list of table names to copy.; 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:: edmserver.cmd.CopyAndRefreshSiteDataCmdExecutor

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:: edmserver.cmd.CopyCompanyCmdExecutor

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.; toLocations - Comma-separated list of site IDs to copy to.; tableList - Name of a table list or a comma-separated list of table names to copy.; 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:: edmserver.cmd.CopySiteDataCmdExecutor

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, configurationType, versionId)
Parameters:: configurationTypeID - ID of the configuration type for which the version data site is being created.; configurationType - 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:: edmserver.plugin.mdm.cmd.CreateConfigVersionDataSiteCmdExecutor

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:: edmserver.cmd.CreateRemoteInstallerCmdExecutor

createTransactionTriggers

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

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:: edmserver.cmd.CreateTransactionTriggersCmdExecutor

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:: edmserver.ServerFunctions

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:: edmserver.ServerFunctions

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:: edmserver.cmd.EditSnapshotTablesCmdExecutor

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 transferred without the site ID path segment, e.g. "outgoing/".; encryptedCredentials - AWS credentials encrypted with the EncryptAmazonCredentialsCmd object.
Returns:: Void
Class:: edmserver.cmd.DeleteTransactionFilesFromAmazonCmdExecutor

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:: edmserver.plugin.mdm.cmd.DeployMasterChangesCmdExecutor

enableProfile

Enable profiling.

Syntax:: enableProfile()
Parameters:: none
Returns:: True if profiling was previously enable.
Class:: edmserver.cmd.EnableProfileCmdExecutor

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:: edmserver.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.; sql - SQL statement to execute.
Returns:: DataSet
Class:: edmserver.cmd.ExecuteQueryCmdExecutor

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.; 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:: edmserver.ServerFunctions

exportSecurityPolicyToXml

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

Syntax:: exportSecurityPolicyToXml( 'file')
Parameters:: file - File path and name.
Returns:: Void.
Class:: edmserver.cmd.ExportSecurityPolicyToXmlCmdExecutor

exportSelectedDataToFile

Export data to a file from a table

Syntax:: exportSelectedDataToFile( 'siteList', useShareGroupNumbers, 'filePathAndName', addNameRow, isDelimited, 'delimiter', 'columnLengths', 'dateFormat', 'source')
Parameters:: siteList - Either a star (*) or a comma delimited list of sites to export; useShareGroupNumbers - Boolean on whether or not to use the share group numbers instead of the real location ids.; filePathAndName - File path and name of file to be exported to.; addNameRow - Boolean to show or hide the column names as the first row.; isDelimited - Boolean -- whether or not the data should be delimited. This will override the column widths if both are set.; delimiter - The string character -- either a comma or semicolon -- that is used to delimit columns.; columnLengths - A comma delimited list of the widths of the columns for a fixed length export.; dateFormat - A string of the format to use for dates. Defaults to GDT.; source - The table name or query name to be exported.
Returns:: Void.
Class:: edmserver.ServerFunctions

fileExists

Returns true if the given file or directory exists.

Syntax:: fileExists( 'filePath')
Parameters:: filePath - Path and name of the file to check.
Returns:: Boolean.
Class:: edmserver.function.FileExistsFunction

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:: edmserver.cmd.GenerateFunctionHelpCmdExecutor

getAppObject

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

Syntax:: getAppObject( 'objectType', 'objectName')
Parameters:: objectType - Type of application object (table, query, form, report).; objectName - Name of application object.
Returns:: Application object or null if not found.
Class:: edmserver.cmd.GetAppObjectCmdExecutor

getConfigProperty

Get configuration property value.

Syntax:: getConfigProperty( 'propertyName')
Parameters:: propertyName - Name of the property.
Returns:: Property value or null if not found.
Class:: edmserver.cmd.GetConfigPropertyCmdExecutor

getConfigPropertyWithDefault

Get configuration property value.

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:: edmserver.cmd.GetConfigPropertyCmdExecutor

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:: edmserver.cmd.GetIniFileValueCmdExecutor

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:: edmserver.plugin.mdm.cmd.GetMasterTableConfigurationTypeCmdExecutor

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:: edmserver.cmd.GetNextUnusedIdCmdExecutor

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:: edmserver.cmd.GetPropertyFileValueCmdExecutor

getRegistryValue

Returns the value from the Windows registry for the given key, value, and substring.

Syntax:: getRegistryValue( 'key', 'value', 'substring')
Parameters:: key - Registry key to use in the HKEY_LOCAL_MACHINE section of the registry.; value - Value in the given key to retrieve.; substring - Portion of registry value to return when value is of the form 'substring1=value1;substring2=value2;...'. Ignored if null or blank.
Returns:: Registry value.
Class:: edmserver.ServerFunctions

getReportConfig

Return the ReportConfig stored in the given file.

Syntax:: getReportConfig( 'settingFile')
Parameters:: settingFile - File containing the report configuration.
Returns:: ReportConfig.
Class:: edmserver.cmd.GetReportConfigCmdExecutor

getServerTime

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

Syntax:: getServerTime()
Parameters:: none
Returns:: Integer.
Class:: edmserver.cmd.GetServerTimeCmdExecutor

getSessions

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

Syntax:: getSessions()
Parameters:: none
Returns:: String.
Class:: edmserver.cmd.GetSessionsCmdExecutor

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:: edmserver.ServerFunctions

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:: edmserver.ServerFunctions

getUnlockedPackageVersions

Get a ValueList of version ids and names that are not referenced by unlocked packages.

Syntax:: getUnlockedPackageVersions( 'packageId')
Parameters:: packageId - The ID of the package that will be included in the list, regardless whether or not it is unlocked. For example, the package currently being edited.
Returns:: String.
Class:: edmserver.plugin.mdm.function.GetUnlockedPackageVersionsFunction

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:: edmserver.cmd.GetValueListOfUsersWithRoleCmdExecutor

getVersion

Return the current version of EDM

Syntax:: getVersion()
Parameters:: none
Returns:: The current version of EDM
Class:: edmcommon.function.CommonFunctions

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

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.; 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:: edmserver.ServerFunctions

importFile

Imports a text file to a table.

Syntax:: importFile( 'filename')
Parameters:: filename - Name of the text file to import.
Returns:: Void.
Class:: edmserver.ServerFunctions

importTransactionsFromFile

Import transactions from a CSV file.

Syntax:: importTransactionsFromFile( 'filename')
Parameters:: filename - Name of the CSV file on the server containing transaction information.
Returns:: Number of transactions imported.
Class:: edmserver.cmd.ImportTransactionsFromFileCmdExecutor

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:: edmserver.cmd.EditSnapshotTablesCmdExecutor

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

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.; locationNumber - Location number of the location whose data is being loaded.; dataSourceName - Name of data source from which to load table data.
Returns:: Void.
Class:: edmserver.ServerFunctions

loadCentralSchema

Load schema for a central database table

Syntax:: loadCentralSchema( 'tableName', 'dataSourceName', 'tableVersion')
Parameters:: tableName - Name of table whose schema is to be loaded; dataSourceName - Name of data source from which to load table schema; tableVersion - Version number of table
Returns:: Void.
Class:: edmserver.cmd.AttachTableCmdExecutor

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

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

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:: edmserver.cmd.NotifyClientsCmdExecutor

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

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:: edmserver.cmd.PartitionTableCmdExecutor

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:: edmserver.function.ProcessForcedTransactionsServerFunction

processTransactions

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

Syntax:: processTransactions( 'siteIdList')
Parameters:: siteIdList - Comma-separated list of site id numbers (* means all sites).
Returns:: Void.
Class:: edmserver.function.ProcessTransactionsServerFunction

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. ('*' means all).; siteIdList - Comma-separated list of site IDs ('*' means all).; directory - Directory where published data files are to be stored.
Returns:: Void.
Class:: edmserver.plugin.mdm.cmd.PublishMasterDataCmdExecutor

publishMasterDataTables

Syntax:: publishMasterDataTables( 'tableNameList', 'siteIdList', 'directory')
Parameters:: tableNameList - Comma-separated list of table names to publish ('*' means all).; siteIdList - Comma-separated list of site IDs ('*' means all).; directory - Directory where published data files are to be stored.
Returns:: Void.
Class:: edmserver.plugin.mdm.cmd.PublishMasterDataCmdExecutor

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.; siteIdList - Comma-separated list of site IDs whose data is to be published ('*' means all).; directory - Directory where published data files are to be stored.
Returns:: Void.
Class:: edmserver.plugin.mdm.cmd.PublishXCEDataCmdExecutor

publishXCEDataTables

Syntax:: publishXCEDataTables( 'tableNameList', 'siteIdList', 'directory')
Parameters:: tableNameList - Comma-separated list of table names to publish ('*' means all).; siteIdList - Comma-separated list of site IDs whose data is to be published ('*' means all).; directory - Directory where published data files are to be stored.
Returns:: Void.
Class:: edmserver.plugin.mdm.cmd.PublishXCEDataCmdExecutor

purgeAuditTrail

Delete audit trail rows that are older than the given number of days.

Syntax:: purgeAuditTrail( daysToKeep)
Parameters:: daysToKeep - Number of days of history to keep.
Returns:: Void.
Class:: edmserver.ServerFunctions

purgePollData

Delete polled table rows that are older than the given number of days.

Syntax:: purgePollData( daysToKeep)
Parameters:: daysToKeep - Number of days of history to keep.
Returns:: Void.
Class:: edmserver.ServerFunctions

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:: edmserver.cmd.QueryValueCmdExecutor

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:: edmserver.cmd.QueryValueCmdExecutor

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:: edmserver.cmd.QueryValueCmdExecutor

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:: edmserver.cmd.QueryValueCmdExecutor

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:: edmserver.cmd.QueryValueCmdExecutor

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:: edmserver.cmd.QueryValueCmdExecutor

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:: edmserver.cmd.QueryValueCmdExecutor

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 connection.

Syntax:: receiveSiteFilesViaWeb( 'siteIdList')
Parameters:: siteIdList - Comma-separated list of Location id's to transfer, * means all sites).
Returns:: Void.
Class:: edmserver.cmd.TransferFilesCmdExecutor

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:: edmserver.cmd.ReceiveTransactionFilesFromAmazonCmdExecutor

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, '*' 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:: edmserver.cmd.ReceiveTransactionFilesFromJMSCmdExecutor

reloadCachedData

Reload all data cached in server memory on the server and re-initialize system.

Syntax:: reloadCachedData()
Parameters:: none
Returns:: Void.
Class:: edmserver.cmd.ReloadCachedDataCmdExecutor

removeAmazonCommitListener

Reomve listener that sends outgoing transaction files for selected sites to Amazon as soon as they are committed.

Syntax:: removeAmazonCommitListener( 'siteIdList', 'bucketName', 'prefix', 'encryptedCredentials')
Parameters:: siteIdList - Comma-separated list of site id numbers (* means all sites).; bucketName - Name of Amazon S3 bucket containing incoming and outgoing directories.; 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:: Boolean - True if listener was removed.
Class:: edmserver.function.AddAmazonCommitListenerFunction

removeTransactionsProcessedListener

Remove listener that evaluates the given expression whenever transaction processing completes.

Syntax:: removeTransactionsProcessedListener( 'expression')
Parameters:: expression - Expression to evaluate after transaction processing completes.
Returns:: Void.
Class:: edmserver.function.AddTransactionsProcessedListenerFunction

replaceAll

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

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

requestFile

Copy a file to other locations

Syntax:: requestFile( 'locationList', 'fromFile', 'toFile', overwrite, synchronize, 'effectiveDate', 'packageName', 'packageDescription', forceProcessing)
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); overwrite - True if file should be overwritten if it exists at destination location.; synchronize - True 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.; forceProcessing - True if transaction should be processed when only processing forced transactions.
Returns:: Void.
Class:: edmserver.cmd.WriteFileTransactionCmdExecutor

requestTableListRefresh

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

Syntax:: requestTableListRefresh( 'tableList', 'siteIdList', forceProcessing, 'packageName', 'packageDescription', 'rollBackType', 'rollBackDate', 'rollBackTime')
Parameters:: tableList - Comma-delimited list of table names.; siteIdList - Comma-delimited list of site IDs whose table data is being requested.; 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'.; 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:: edmserver.cmd.TableListRefreshCmdExecutor

requestTableRefresh

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

Syntax:: requestTableRefresh( 'snapshotName', 'selectedLocations', forceProcessing, '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).; 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
Returns:: Void.
Class:: edmserver.cmd.TableRefreshCmdExecutor

resetSites

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

Syntax:: resetSites( 'siteList')
Parameters:: siteList - Comma-separated list of site IDs to reset.
Returns:: void
Class:: edmserver.cmd.ResetSitesCmdExecutor

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:: edmserver.cmd.RestoreTestCheckpointCmdExecutor

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

Execute the given command line. For example, to open the config.xml file in notepad execute the command c:\windows\system32\notepad.exe c:\edmweb\config.xml, and the wait flag to false. To run a batch file you could execute the command cmd /c c:\edmweb\go.bat and the wait flag to false.

Syntax:: runApp( 'commandLine', wait)
Parameters:: commandLine - Command line to execute.; wait - Wait for application to complete before returning.
Returns:: 0 if successful, otherwise error code.
Class:: edmserver.cmd.RunAppCmdExecutor

runJUnitTest

Run the JUnit tests in the given class.

Syntax:: runJUnitTest( 'jUnitClassName')
Parameters:: jUnitClassName - JUnit test class to run.
Returns:: Void.
Class:: edmserver.cmd.RunJUnitTestCmdExecutor

runReport

Run a report.

Syntax:: runReport( 'outputFileName', 'dataSourceName', 'dataSetClass', 'jrxmlFileName', parameters, 'outputType')
Parameters:: outputFileName - The name of the output report file..; dataSourceName - The data source name to use when gathering data for the report.; dataSetClass - Class that implements the {@link ReportDataSetGenerator} to collect data for a report. Null means use the data source instead..; jrxmlFileName - The name of the Jasper jrxml file.; parameters - Map of parameter names and values.; outputType - Report output type 'PDF', 'HTML', or 'XML'.
Returns:: String containing the fully qualified report file name.
Class:: edmserver.cmd.RunReportCmdExecutor

runSQL

Executes an insert, update, delete, or maketable SQL statement.

Syntax:: runSQL( 'sql')
Parameters:: sql - Insert, update, delete, or maketable SQL statement to execute.
Returns:: Void.
Class:: edmserver.ServerFunctions

sendDeleteFileTransaction

Send transaction to delete a file.

Syntax:: sendDeleteFileTransaction( 'file', 'siteList', 'effectiveDate', 'packageName', 'packageDescription')
Parameters:: file - File name to delete (blank means prompt user to select).; siteList - Comma-separated list of site numbers (blank means prompt user, * means all sites).; effectiveDate - Date/time transaction should be applied.; packageName - Name of package to hold transactions.; packageDescription - Description of package if new package.
Returns:: Void.
Class:: edmserver.cmd.SendDeleteFileTransactionCmdExecutor

sendEvaluateTransaction

Send a transaction to cause the receiver to evaluate an expression.

Syntax:: sendEvaluateTransaction( 'expression', 'siteIdList', 'effectiveDate', 'packageName', 'packageDescription', forceProcessing)
Parameters:: expression - Expression to evaluate on receiving server (uses only server functions).; siteIdList - Comma-separated list of site numbers (blank means prompt user, * means all sites).; effectiveDate - Date/time transaction should be applied in local format or blank to be effective immediately.; packageName - Name of package to hold transactions.; packageDescription - Description of package if new package.; forceProcessing - True if transactions should be processed when only processing forced transactions.
Returns:: CommitPromptInfo
Class:: edmserver.cmd.SendEvaluateTransactionCmdExecutor

sendExecuteTransaction

Send transaction to execute an operation system command at selected sites.

Syntax:: sendExecuteTransaction( 'file', 'arguments', wait, 'siteList', 'effectiveDate', 'packageName', 'packageDescription', forceProcessing)
Parameters:: file - Full path of executable file (if blank, prompt user to select); arguments - Command line arguments.; wait - True if call should wait for process to complete before returning.; siteList - Comma-separated list of site numbers (blank means prompt user, * means all sites).; effectiveDate - Date/time transaction should be applied.; packageName - Name of package to hold transactions.; packageDescription - Description of package if new package.; forceProcessing - True if transactions should be processed when only processing forced transactions.
Returns:: Void.
Class:: edmserver.cmd.SendExecuteTransactionCmdExecutor

sendFile

Send a file to other locations

Syntax:: sendFile( 'locationList', 'fromFile', 'toFile', overwrite, synchronize, 'effectiveDate', 'packageName', 'packageDescription', forceProcessing)
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); overwrite - True if file should be overwritten if it exists at destination location.; synchronize - True 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.; forceProcessing - True if transaction should be processed when only processing forced transactions.
Returns:: Void.
Class:: edmserver.cmd.WriteFileTransactionCmdExecutor

sendRemoteFiles

Send files listed in remote files table to sites.

Syntax:: sendRemoteFiles( sendUpdatedOnly, 'siteIdList', 'effectiveDate', 'packageName', 'packageDescription', forceProcessing, commit)
Parameters:: sendUpdatedOnly - True if only files that have been updated should be sent.; siteIdList - Comma-separated list of site numbers to which files should be sent (* means all, blank means prompt user to select).; effectiveDate - Date file should be copied to destination; 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; forceProcessing - True if transactions should be processed when only processing forced transactions.; commit - True if package containing file transactions should be committed.
Returns:: Void.
Class:: edmserver.ServerFunctions

sendSiteFilesViaWeb

Send transaction files over HTTP connection.

Syntax:: sendSiteFilesViaWeb( 'siteIdList')
Parameters:: siteIdList - Comma-separated list of Location id's to transfer, * means all sites).
Returns:: Void.
Class:: edmserver.cmd.TransferFilesCmdExecutor

sendSynchronizeDirectoryTransaction

Send a transaction to synchronize a local directory with a directory at other sites.

Syntax:: sendSynchronizeDirectoryTransaction( 'siteIdList', 'sourceDirectory', 'destinationDirectory', sourceDirectoryIsOnSender, deleteMissingFiles, includeSubdirectories, 'effectiveDate', forceProcessing, 'packageName', 'packageDescription')
Parameters:: siteIdList - Comma-separated list of site IDs to which transaction will be sent (blank means prompt user, * means all sites).; sourceDirectory - Directory containing up-to-date files.; destinationDirectory - Directory that should be updated to match source directory.; sourceDirectoryIsOnSender - True if the source directory is on the local network of the system sending the transaction.; deleteMissingFiles - True if files in the destination directory should be deleted if they do not exist in the source directory.; includeSubdirectories - True if subdirectories should also be synchronized.; effectiveDate - Effective date of transaction.; forceProcessing - True if processed when only processing forced transactions.; packageName - Name of package to hold transactions.; packageDescription - Description of package if new package.
Returns:: Void.
Class:: edmserver.cmd.SendSyncDirectoryTranCmdExecutor

sendTableListRefresh

Send table data to locations to replace existing data

Syntax:: sendTableListRefresh( 'tableList', 'siteIdList', destinationSiteId, forceProcessing, 'packageName', 'packageDescription', 'rollBackType', 'rollBackDate', 'rollBackTime', autoCommit)
Parameters:: tableList - Comma-delimited list of table names.; siteIdList - Comma-delimited list of site IDs whose table data is being requested.; destinationSiteId - Null if sending site data to same site, otherwise the site id of the test/lab site where the real site's data is to be sent.; 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.; autoCommit - True if refresh transaction should be committed as soon as it is generated.
Returns:: Void.
Class:: edmserver.cmd.TableListRefreshCmdExecutor

sendTableRefresh

Send table data to locations to replace existing data

Syntax:: sendTableRefresh( 'snapshotName', 'selectedLocations', forceProcessing, '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).; 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
Returns:: Void.
Class:: edmserver.cmd.TableRefreshCmdExecutor

sendTransactionFilesToAmazon

Send transaction files to Amazon Simple Storage Service (S3).

Syntax:: sendTransactionFilesToAmazon( 'siteIdList', 'bucketName', 'prefix', 'encryptedCredentials')
Parameters:: siteIdList - Comma-separated list of site IDs to send (* means all sites).; bucketName - Name of Amazon S3 bucket containing incoming and outgoing directories.; 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:: edmserver.cmd.SendTransactionFilesToAmazonCmdExecutor

sendTransactionFilesToJMS

Send outgoing files for the given sites to a JMS queue.

Syntax:: sendTransactionFilesToJMS( 'siteIdList', 'queueName', 'brokerURL', 'userId', 'password')
Parameters:: siteIdList - Comma-separated list of site IDs to send (* for all locations).; queueName - Name of the queue where outgoing transaction files should be sent. For example: edm.outgoing.%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:: edmserver.cmd.SendTransactionFilesToJMSCmdExecutor

sendTransactionFilesToJMSWithRetry

Send outgoing files for the given sites to a JMS queue. If the transfer fails due to a JMS error, the listener will retry after 15 seconds, 30 seconds, then 1 minute, 2 minutes, 4 minutes, 8 minutes, then every 15 minutes until the transfer works.

Syntax:: sendTransactionFilesToJMSWithRetry( 'siteIdList', 'queueName', 'brokerURL', 'userId', 'password', retrySeconds)
Parameters:: siteIdList - Comma-separated list of site IDs to send (* for all locations).; queueName - Name of the queue where outgoing transaction files should be sent. For example: edm.outgoing.%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.; retrySeconds - Number of seconds we waited before previous retry if the call fails. 0 means this is the first retry.
Returns:: Void.
Class:: edmserver.cmd.SendTransactionFilesToJMSCmdExecutor

setConfigProperty

Set configuration property value.

Syntax:: setConfigProperty( 'propertyName', 'value')
Parameters:: propertyName - Name of the user property.; value - New property value.
Returns:: Old property value.
Class:: edmserver.cmd.SetConfigPropertyCmdExecutor

setLastReceivedTranFileNumberToIncoming

Set the last received transaction file number for a site to the lowest transaction file number in the incoming directory - 1.

Syntax:: setLastReceivedTranFileNumberToIncoming( siteId)
Parameters:: siteId - ID of the site whose last received transaction file number is to be set.
Returns:: Void.
Class:: edmserver.cmd.SetLastReceivedTranFileNumberToIncomingCmdExecutor

setPropertyFileValue

Set the value of a property in a property file.

Syntax:: setPropertyFileValue( 'propertyName', 'propertyValue', 'propertyFileName', createFile, 'comments')
Parameters:: propertyName - Name of the property whose value is to be returned.; propertyValue - Property value.; propertyFileName - Path and name of property file.; createFile - True if property file should be created if it does not exist.; comments - Comments to add at the beginning of the property file or null for none.
Returns:: Void.
Class:: edmserver.cmd.SetPropertyFileValueCmdExecutor

space

Creates a string of blanks

Syntax:: space( count)
Parameters:: count - Number of blanks to put in the string
Returns:: String of blanks
Class:: edmcommon.function.CommonFunctions

stringToDate

Converts a date string to a date value

Syntax:: stringToDate( 'date', 'format')
Parameters:: date - Date string to convert; format - Format string to use
Returns:: Date value
Class:: edmcommon.function.CommonFunctions

stringToInt

Converts a string to an integer.

Syntax:: stringToInt( 'string')
Parameters:: string - String to convert
Returns:: Integer value.
Class:: edmcommon.function.CommonFunctions

stringToNumber

Converts a string to a number

Syntax:: stringToNumber( 'number')
Parameters:: number - Number string to convert
Returns:: Number value
Class:: edmcommon.function.CommonFunctions

stringToTime

Converts a time string to a time value

Syntax:: stringToTime( 'time', 'format')
Parameters:: time - Time string to convert; format - Format string to use
Returns:: Time value
Class:: edmcommon.function.CommonFunctions

stringToTimestamp

Converts a timestamp string to a timestamp value

Syntax:: stringToTimestamp( 'timestamp', 'format')
Parameters:: timestamp - Timestamp string to convert; format - Format string to use
Returns:: Date value
Class:: edmcommon.function.CommonFunctions

substring

Returns characters from the middle of a string

Syntax:: substring( 'astring', pos, count)
Parameters:: astring - String to get the characters from; pos - Index of the first character to get; count - Number of characters to get
Returns:: Requested characters
Class:: edmcommon.function.CommonFunctions

synchronizeSitePropertyValues

Imort and sync the site property values from an outside data source

Syntax:: synchronizeSitePropertyValues( 'DSN', 'SQL', 'tableName', 'LocationIdColName', 'LocationNameColName')
Parameters:: DSN - The string of the connection in the config.xml to be used to run the SQL. Required.; SQL - The SQL string to be executed to get the source data.; tableName - The name of the table the SQL is executed against.; LocationIdColName - The column name of the location id field. Blank defaults to "Location".; LocationNameColName - The column name of the location name field. Blank defaults new stores to "Store " for a name and no updates to the existing location names will be performed.
Returns:: Void.
Class:: edmserver.ServerFunctions

time

Gets current time of day

Syntax:: time( 'format')
Parameters:: format - Format string describing how the date should be formatted.
Returns:: Current time formatted using format string
Class:: edmcommon.function.CommonFunctions

timestamp

Get current date and time.

Syntax:: timestamp( 'format')
Parameters:: format - Format string describing how the date and time should be formatted.
Returns:: String representation of the current date and time.
Class:: edmcommon.function.CommonFunctions

timestampToDate

Converts a timestamp to a date

Syntax:: timestampToDate( 'timestamp')
Parameters:: timestamp - Timestamp to convert
Returns:: Date part of the timestamp
Class:: edmcommon.function.CommonFunctions

timestampToNumber

Converts a timestamp to a number

Syntax:: timestampToNumber( 'timestamp')
Parameters:: timestamp - Timestamp to convert
Returns:: Number representing the timestamp
Class:: edmcommon.function.CommonFunctions

timestampToString

Converts a timestamp to a character string

Syntax:: timestampToString( 'timestamp', 'format')
Parameters:: timestamp - Date to convert; format - Format string to use
Returns:: String representation of the timestamp
Class:: edmcommon.function.CommonFunctions

timestampToTime

Converts a timestamp to a time

Syntax:: timestampToTime( 'timestamp')
Parameters:: timestamp - Timestamp to convert
Returns:: Time part of the timestamp
Class:: edmcommon.function.CommonFunctions

timeToNumber

Converts a time to a number

Syntax:: timeToNumber( 'time')
Parameters:: time - Time to convert
Returns:: Number representing the time
Class:: edmcommon.function.CommonFunctions

timeToString

Converts a time to a character string

Syntax:: timeToString( 'time', 'format')
Parameters:: time - Time to convert; format - Format string to use
Returns:: String representation of the time
Class:: edmcommon.function.CommonFunctions

timeToTimestamp

Converts a time to a timestamp

Syntax:: timeToTimestamp( 'time')
Parameters:: time - Time to convert
Returns:: Timestamp with date part set to 01/01/01
Class:: edmcommon.function.CommonFunctions

transferSiteFilesViaFTP

Transfer transaction files over FTP connection.

Syntax:: transferSiteFilesViaFTP( 'siteIdList')
Parameters:: siteIdList - Comma-separated list of Location id's to transfer, * means all sites).
Returns:: Void.
Class:: edmserver.cmd.TransferFilesCmdExecutor

transferSiteFilesViaRAS

Transfer transaction files over network connection.

Syntax:: transferSiteFilesViaRAS( 'siteIdList')
Parameters:: siteIdList - Comma-separated list of Location id's to transfer, * means all sites).
Returns:: Void.
Class:: edmserver.cmd.TransferFilesCmdExecutor

transferSiteFilesViaWeb

Transfer transaction files over HTTP connection.

Syntax:: transferSiteFilesViaWeb( 'siteIdList')
Parameters:: siteIdList - Comma-separated list of Location id's to transfer, * means all sites).
Returns:: Void.
Class:: edmserver.cmd.TransferFilesCmdExecutor

trim

Trims the blanks from both ends of a string

Syntax:: trim( 'string')
Parameters:: string - String to trim
Returns:: Trimmed string
Class:: edmcommon.function.CommonFunctions

trimLeft

Trims the blanks from the left end of a string

Syntax:: trimLeft( 'string')
Parameters:: string - String to trim
Returns:: Trimmed string
Class:: edmcommon.function.CommonFunctions

trimRight

Trims the blanks from the right end of a string

Syntax:: trimRight( 'string')
Parameters:: string - String to trim
Returns:: Trimmed string
Class:: edmcommon.function.CommonFunctions

updateAmazonDirToMatchLocalDir

Update an Amazon S3 directory to match a local directory.

Syntax:: updateAmazonDirToMatchLocalDir( 'serverDirectory', 'localDirectory', deleteMissingFiles, 'bucketName', 'encryptedCredentials')
Parameters:: serverDirectory - Directory on the server to update to match the files in the local directory.; localDirectory - Local directory to check for new, updated, and deleted files.; deleteMissingFiles - True if files in the S3 directory should be deleted if they do not exist in the local directory.; bucketName - Name of Amazon S3 bucket containing server directory.; encryptedCredentials - AWS credentials encrypted with the EncryptAmazonCredentialsCmd object.
Returns:: Void
Class:: edmserver.cmd.UpdateAmazonDirToMatchLocalDirCmdExecutor

updateLocalDirToMatchAmazonDir

Update a local directory to match a directory on Amazon S3.

Syntax:: updateLocalDirToMatchAmazonDir( 'serverDirectory', 'localDirectory', deleteMissingFiles, 'bucketName', 'encryptedCredentials')
Parameters:: serverDirectory - Server directory containing files and sub-directories.; localDirectory - Local directory to synchronize.; deleteMissingFiles - True if files in the local directory should be deleted if they do not exist on the server.; bucketName - Name of Amazon S3 bucket containing server directory.; encryptedCredentials - AWS credentials encrypted with the EncryptAmazonCredentialsCmd object.
Returns:: Void
Class:: edmserver.cmd.UpdateLocalDirToMatchAmazonDirCmdExecutor

updateLocalDirToMatchWebDir

Update a local directory to match a directory on the EDM web server.

Syntax:: updateLocalDirToMatchWebDir( 'serverDirectory', 'localDirectory', deleteMissingFiles)
Parameters:: serverDirectory - Server directory containing files and sub-directories.; localDirectory - Local directory to synchronize.; deleteMissingFiles - True if files in the local directory should be deleted if they do not exist on the server.
Returns:: Void
Class:: edmserver.cmd.UpdateLocalDirToMatchWebDirCmdExecutor

updateTableList

Update a table list.

Syntax:: updateTableList( 'oldTableListName', tableList, index)
Parameters:: oldTableListName - New table list to insert.; tableList - New table list.; index - 0-based index where table list should be inserted after deleting original table list, if index is < 0 or >= list size, the new table list is inserted at the same index as the original table list.
Returns:: Void.
Class:: edmserver.cmd.EditSnapshotTablesCmdExecutor

updateTransferSettings

Save the given transfer host, user ID, password, and company name used to connect to a central EDM server

The updateTransferSettings function updates the transfer host, user ID, password, and company name on the central site record. This information is used when connecting to the central system to transfer transaction files. To have the information automatically saved when the system starts up, the function can be called in the onStartupProperty of config.xml as shown in the following example.

onStartup = "updateTransferSettings( 'localhost:8080/edm', 'remote', 'remote', 'HQ' )"

Syntax:: updateTransferSettings( 'hostName', 'userId', 'password', 'company')
Parameters:: hostName - Host name for file transfers.; userId - User id for transaction file transfers.; password - Password for transaction file transfers.; company - Company name for transaction file transfers.
Returns:: Void.
Class:: edmserver.cmd.UpdateTransferSettingsCmdExecutor

updateWebDirToMatchLocalDir

Update an directory on the EDM web server to match a local directory.

Syntax:: updateWebDirToMatchLocalDir( 'serverDirectory', 'localDirectory', deleteMissingFiles)
Parameters:: serverDirectory - Directory on the server to update to match the files in the local directory.; localDirectory - Local directory to check for new, updated, and deleted files.; deleteMissingFiles - True if files in the server directory should be deleted if they do not exist in the local directory.
Returns:: Void
Class:: edmserver.cmd.UpdateWebDirToMatchLocalDirCmdExecutor

upper

Changes each letter of a string to upper case

Syntax:: upper( 'string')
Parameters:: string - String to convert
Returns:: String converted to upper case
Class:: edmcommon.function.CommonFunctions

validateTableList

Validate references between tables

Syntax:: validateTableList( 'tableListName', 'siteIdList')
Parameters:: tableListName - Name of the table list containing the list of tables to validate.; siteIdList - List of comma-separated location ID's of the locations from which to get the test records (* means all locations).
Returns:: Server file reference.
Class:: edmserver.cmd.ValidateTableListCmdExecutor

validateTables

Validate references between tables

Syntax:: validateTables( 'tableNames', 'siteIdList')
Parameters:: tableNames - Comma-separated list of tables to validate (* means all tables).; siteIdList - Comma-separated list of site IDs to validate (* means all sites).
Returns:: Server file reference.
Class:: edmserver.cmd.ValidateTablesCmdExecutor

year

Returns the year value of a date

Syntax:: year( 'date')
Parameters:: date - Date to get the year from
Returns:: Four digit year number
Class:: edmcommon.function.CommonFunctions