Audit functions

CreateAuditEntry

Declaration

bool CreateAuditEntry(JournalStore store, int action, int result)

Description

Creates a new audit trail entry and writes it to the repository.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0

Parameters	Description
store	The journal store the audit entry belongs to.
action	The action that has been executed.
result	The result of the execution.

Return Value

True, if the entry's attributes are valid, false otherwise.

CreateAuditEntry

Declaration

bool CreateAuditEntry(JournalStore store, int action, int result, string year, string period, string scenario, string group)

Description

Creates a new audit trail entry and writes it to the repository.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0

Parameters	Description
store	The journal store the audit entry belongs to.
action	The action that has been executed.
result	The result of the execution.
year	The year where the action has been executed.
period	The period where the action has been executed.
scenario	The scenario where the action has been executed.
group	The group where the action has been executed.

Return Value

True, if the entry's attributes are valid, false otherwise.

CreateAuditEntry

Declaration

bool CreateAuditEntry(JournalStore store, int action, int result, string year, string period, string scenario, string group, string extendedInformation)

Description

Creates a new audit trail entry and writes it to the repository.

Supported Runtime Versions

1.0, 2.0, 3.0, 4.0, 5.0

Parameters	Description
store	The journal store the audit entry belongs to.
action	The action that has been executed.
result	The result of the execution.
year	The year where the action has been executed.
period	The period where the action has been executed.
scenario	The scenario where the action has been executed.
group	The group where the action has been executed.
extendedInformation	Extended information corresponding to the action.

Return Value

True, if the entry's attributes are valid, false otherwise.

CreateAuditEntry

Declaration

bool CreateAuditEntry(RepositoryConnection connection, int action, string auditInfo1, string auditInfo2, string auditInfo3, string auditInfo4, string auditInfo5, string auditInfo6, string auditInfo7, string auditInfo8, string auditInfo9, string auditInfo10, string auditInfo11, string auditInfo12, string auditInfo13, string auditInfo14)

Description

Creates a custom entry in the audit log.

Supported Runtime Versions

3.0, 4.0, 5.0

Parameters	Description
connection	Repository connection to be used for logging the custom audit entry.
action	ID uniquely identifying the custom action to be logged. The ID must be greater or equal 1000.
auditInfo1	Additional information #1 describing the event. Can be up to 72 characters long.
auditInfo2	Additional information #2 describing the event. Can be up to 72 characters long.
auditInfo3	Additional information #3 describing the event. Can be up to 72 characters long.
auditInfo4	Additional information #4 describing the event. Can be up to 200 characters long.
auditInfo5	Additional information #5 describing the event. Can be up to 200 characters long.
auditInfo6	Additional information #6 describing the event. Can be up to 200 characters long.
auditInfo7	Additional information #7 describing the event. Can be up to 500 characters long.
auditInfo8	Additional information #8 describing the event. Can be up to 500 characters long.
auditInfo9	Additional information #9 describing the event. Can be up to 500 characters long.
auditInfo10	Additional information #10 describing the event. Can be up to 2000 characters long.
auditInfo11	Additional information #11 describing the event. Can be up to 2000 characters long.
auditInfo12	Additional information #12 describing the event. Can be up to 2000 characters long.
auditInfo13	Additional information #13 describing the event. Can be arbitrarily long.
auditInfo14	Additional information #14 describing the event. Can be arbitrarily long.

Return Value

True, if the entry could be created, false otherwise.