Page History

Usage:
Database_Services('VerifyLHAll', ErrorMessage)

Comments:
Sets an error to the stack. This will automatically clear any existing error conditions first so this error will be the only one on the stackPerforms a health check against all attached tables and returns back any issues. Returns two lists which are delimited by an @RM. The first list is an @FM list of attached tables. The second list is an @FM list of results (groups that have GFEs or an empty string if there are none). Items in each list correspond which each other based on their list position.

Returns:
N/A 

Usage:
Database_Services('VerifyLH', ErrorMessage Tablenames, SaveList)

Comments:
Adds an error to the stack. This will not clear existing error conditions first. It is intended to allow higher level routines to add more information to an existing error condition or simply to maintain an ongoing error log for some troubleshooting or debugging purposesPerforms a health check against the indicated tables and returns back any issues. Note: This uses the Verify_LH subroutine to check for GFEs. All results are stored in the SYSLHVERIFY table with a KeyID of VolumeLabel*DatabaseID*TableName. Returns the list of groups that have GFEs or returns an empty string if there are none. The list of GFEs or empty strings will themselves be @FM delimited to correspond with the tables passed into this service.

Returns:
N/A

Usage:
Database_Services('GetTableProperties', TableName)

Comments:
Clears all error conditions and related informationReturns an array of information related to the database table being passed in.

Returns:
N/A

GetTableHandle

Usage:
Database_Services('GetTableHandle', TableName)

Comments:
Returns the most current error messagean array of information related to the database table being passed in.

Returns:
The most current error message.

ClearTableHandle

Usage:
Database_Services('ClearTableHandle', TableName)

Comments:
Returns the stack of error messages. This will be @FM delimitedClears the table handle array array from cache. This will force the GetTableHandle service to call the Open statement again.

Returns:
The stack of error messages.

ReadDataRow

Usage:
Database_Services('ReadDataRow', KeyID, NotExpired, ExpirationDuration, IgnoreMFSRoutines)

Comments:
Returns True if there is an error condition, False if there is no error condition. Caller will still need to use the GetMessage or GetMessages service to determine what the error is. The HasError service allows the caller to embed the Error_Services service call inside of a conditional statement like this:

If Error_Services('HasError') then
* An error has occured. Proceed accordingly.
ErrorMessage = Error_Services('GetMessage')
end else
* No error has occured.
end

Reads a data row for the indicated Key ID and database table.

Returns:

True if there is an error condition, False if there is no error condition.

WriteDataRow

Usage:
Database_Services('WriteDataRow', TableName, KeyID, DataRow, IgnoreSelfLock, IgnoreMFSRoutines, IgnoreAllLocks)

Comments:
Returns True if there are no error conditions, False if there is an error condition. This is the opposite of the HasError service and exists for improved readabilityWrites a data row for the indicated Key ID and database table.

Returns:
True if there are no error conditions, False if there is an error condition.

DeleteDataRow

Usage:
Database_Services('DeleteDataRow', TableName, KeyID, IgnoreSelfLock, IgnoreMFSRoutines)

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stockDeletes a data row for the indicated Key ID and database table.

Returns:
N/A

GetKeyIDLock

Usage:
Database_Services('GetKeyIDLock', TableName, KeyID, IgnoreSelfLock)

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.Attempts to perform a semaphore lock on the indicated tablename and Key ID.

Returns:
N/A

ReleaseKeyIDLock

Usage:
Database_Services('ReleaseKeyIDLock', TableName, KeyID)

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stockAttempts to release a semaphore lock on the indicated tablename and Key ID.

Returns:
N/A

SetTableAlias

Usage:
Database_Services('SetTableAlias', TableName, AliasName, Volume, DatabaseID)

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stockAttempts to create an alias for the indicated table, volume, and database. It returns a True$ if successful or a False$ if unsuccessful.

Returns:
N/A

SearchIndex

Usage:
Database_Services('SearchIndex', TableName, ColumnName, SearchValue, UpdateIndex)

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stockReturns an @FM delimited list of Key IDs that match the search value.

Returns:
N/A

CalculateColumn

Usage:
Database_Services('CalculateColumn')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stockCalled directly from within a calculation column. The name of the table and column is derived from the call stack and the associated table commuter, if it exists, is called with the appropriate arguments.

Returns:
N/A

GetTableCommuter

Usage:
Database_Services('GetTableCommuter', TableName)

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.Returns the name of the indicated table's commuter module if it exists. If it does not exist then an empty string will be returned.

Returns:
N/A

GetUserLocks

Usage:
Database_Services('GetUserLocks')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stockReturns a dynamic array of user lock information. Note, this can only be done with the UD 5. This can also cause instability with the current session and may require the Task Manager to close the session.

Returns:
N/A

IsKeyIDLocked

Usage:
Database_Services('IsKeyIDLocked', TableName, KeyID, IgnoreSelfLock)

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.Returns a Boolean flag of the lock status for the indicated table and Key ID.

Returns:
N/A

IsKeyIDSelfLocked

Usage:
Database_Services('IsKeyIDSelfLocked', TableName, KeyID)

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stockReturns a Boolean flag of the self-lock status for the indicated table and Key ID.

Returns:
N/A

UnlockKeyID

Usage:
Database_Services('UnlockKeyID', TableName, KeyID)

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stockAttempts to unlock the indicated Key ID from the indicated Table Name. Note, this can only be done with the UD 5.

Returns:
N/A