TransactionLog.getTransactionLogSettings (Method)

Returns a structure containing information about settings CommonSpot has for the transaction log; for example, its state, the number of days before information is purged, the number of items in the transaction logs, and so on.

Returns:

TransactionLog_GetTransactionLogSettings_Result (struct)

Each row of the returned query results has the following fields:

Field Name	Type	Description
PurgeDays	NonNegativeInteger	The number of days after which CommonSpot will purge the log's transactions. If this value is 0, CommonSpot does not purge the log.
State	TransactionLogState	The state of transaction logging: 'All', 'None', or 'Scheduled'.
TransactionLogEntries	NonNegativeSmallInteger	How many log entries exist.
TransactionLogFirstDate	DateTime_EmptyString	The timestamp of the first transaction log entry. If this is an empty string, no log entries exist.
TransactionLogFirstDateFormatted	String	The formatted timestamp of the first transaction log entry.
TransactionTypeIDList	TransactionLogTypeIDList	A comma-delimited list of zero or more Transaction Type IDs.

Arguments:

Name	Type	Required	Description
scope	PrimaryScope	Required	Scope for the transaction log settings.

Context:

License Requirements	TransactionLogging
Permission Requirements	ContributorOrServerCode
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	Customization is not supported for this method.

Error Codes:

None

Notes:

None