FTransaction

From Dreamtsoft Wiki
Jump to: navigation, search

FTransaction is a unique syntax for the F8 platform. It’s primarily used for tracking and accessing information about transactions taking place.

Common Usage

Listed here are several common usage examples of FTransaction

Set a slot to the currently logged in user

$record.assignment_user = $transaction.getActiveUserRecordId();

Add a comment with the logged in user's name

$record.comments = "Closed by: " + $transaction.getActiveUserName();


Methods

Details Returns


appendOutput(String)
none
getParameter(String)
Get a parameter within a transacton
the parameter value
hasParameter(String)
Checks to see whether a parameter exists within a transacton
true if parameter exists and false if not
setActiveUser(String userID, String userName, String userRecordID)
Sets the active user to the specified user record
none
resetActiveUser()
Resets the active user
none
FTransaction#getUserValue()
Retrieves the active user object
object
getActiveUserId()
Retrieves the active user's "user id" (aka "user name", "login id", "jbennett")
string
getActiveUserName()
Retrieves the active user's full name ("Jerrod Bennett")
string
getActiveUserRecordId()
Retrieves the active user's record's GUID ("c42e70f978124166845be7815f6d0f80")
32 character string
isSuperUser()
Checks to see if the logged in user is in the "administration" group
true if super user and false if not
getRequestHeader(String)
getSessionTimezone()
Returns the timezone of the current session
string
getSessionId()
Returns the id of the session
string
getSessionId()
Returns the id of the session
string
toJSON()
Returns a JSON version of the transaction info
JSON string