| typedef struct AUDIT_log_query_s AUDIT_log_query_t |
| typedef struct AUDIT_record_s AUDIT_record_t |
| SA_API int AUDIT_delete_records | ( | AUDIT_log_query_t | logQuery | ) |
This function is used to delete audit records.
| logQuery | (I) The criteria of audit records to be deleted |
| SA_API int AUDIT_delete_specified_records | ( | int | logCount, | |
| char ** | logUidis | |||
| ) |
| logCount | (I) |
| logUidis | (I) logCount |
| SA_API int AUDIT_get_records | ( | AUDIT_log_query_t | logQuery, | |
| int | nConditions, | |||
| char ** | conditionValues, | |||
| int * | resColCount, | |||
| char *** | resColNames, | |||
| QRY_user_query_row_t ** | resRows | |||
| ) |
This function is used to find audit logs with a specified search conditions.
| logQuery | (I) The search conditions such as user, object name/id, event type, and date. |
| nConditions | (I) The number of search conditions for user defined properties |
| conditionValues | (I) nConditions The search conditions for user defined properties |
| resColCount | (O) The number of result columns |
| resColNames | (OF) resColCount The list of column names |
| resRows | (OF) |
| SA_API int AUDIT_get_records_with_specified_col | ( | AUDIT_log_query_t | logQuery, | |
| int | nConditions, | |||
| char ** | conditionValues, | |||
| int | resColCount, | |||
| char ** | resColNames, | |||
| QRY_user_query_row_t ** | resRows | |||
| ) |
| logQuery | (I) |
| nConditions | (I) |
| conditionValues | (I) nConditions |
| resColCount | (I) |
| resColNames | (I) |
| resRows | (OF) |
| SA_API int AUDIT_get_records_with_specified_col2 | ( | AUDIT_log_query_t | logQuery, | |
| int | nConditions, | |||
| char ** | conditionPropNames, | |||
| char ** | conditionValues, | |||
| int | resColCount, | |||
| char ** | resColNames, | |||
| QRY_user_query_row_t ** | resRows | |||
| ) |
| logQuery | (I) |
| nConditions | (I) |
| conditionPropNames | (I) |
| conditionValues | (I) nConditions |
| resColCount | (I) |
| resColNames | (I) |
| resRows | (OF) |
| SA_API void AUDIT_initialize_log_query | ( | AUDIT_log_query_t * | logQuery | ) |
| logQuery | (O) |
| SA_API int AUDIT_insert_record | ( | AUDIT_record_t | logInfo | ) |
This function is used to create an audit log for an existing audit log data. This function should be used mainly for migrating the older audit log into the new format.
| logInfo | (I) The audit log record to be stored in the audit log storage |
| SA_API int AUDIT_log_event | ( | tag_t | targetObject, | |
| tag_t | objectType, | |||
| tag_t | eventType, | |||
| const char * | objectId, | |||
| const char * | objectName, | |||
| const char * | rev | |||
| ) |
This function is used to create an audit log for an event.
| targetObject | (I) |
| objectType | (I) |
| eventType | (I) |
| objectId | (I) |
| objectName | (I) |
| rev | (I) |
| SA_API int AUDIT_log_event2 | ( | tag_t | targetObject, | |
| tag_t | objectType, | |||
| tag_t | eventType, | |||
| tag_t | subEventType, | |||
| const char * | objectId, | |||
| const char * | objectName, | |||
| const char * | rev | |||
| ) |
This function is used to create an audit log for an events type including __Email_Send, __Email_Not_Send.
| targetObject | (I) |
| objectType | (I) |
| eventType | (I) |
| subEventType | (I) - optional, this is only used for auditing notification email history. In that case, eventType will be __Email_Send or __Email_Not_send, and subEventType field stores the subscribed event name which triggers the notification email send event. |
| objectId | (I) |
| objectName | (I) |
| rev | (I) |
| SA_API int AUDIT_log_event3 | ( | tag_t | targetObject, | |
| tag_t | objectType, | |||
| tag_t | eventType, | |||
| tag_t | subEventType, | |||
| const char * | objectId, | |||
| const char * | objectName, | |||
| const char * | rev, | |||
| int | objectSeq, | |||
| tag_t | secondaryObject, | |||
| int | paramCount, | |||
| const char ** | paramNames, | |||
| const char ** | paramValues, | |||
| int | errorCode, | |||
| const char * | errorMsg | |||
| ) |
This function is used to create an audit log for an events type including __Email_Send, __Email_Not_Send. This supports specifying secondary object, optional parameters to be recorded, along with any error code and error message. All these fields are optional.
| targetObject | (I) |
| objectType | (I) |
| eventType | (I) |
| subEventType | (I) - optional, this is only used for auditing notification email history. In that case, eventType will be __Email_Send or __Email_Not_send, and subEventType field stores the subscribed event name which triggers the notification email send event. |
| objectId | (I) |
| objectName | (I) |
| rev | (I) |
| objectSeq | (I) |
| secondaryObject | (I) - optional. Secondary object involved with the event |
| paramCount | (I) - optional. Count of optional parameters to be recorded |
| paramNames | (I) - optional. Optional parameters to be recorded in audit log |
| paramValues | (I) - optional. Optional parameter values to be recorded in audit log |
| errorCode | (I) - optional. Error code in case of a failure event |
| errorMsg | (I) - optional. Error message in case of a failure event |
| SA_API int AUDIT_log_event4 | ( | tag_t | targetObject, | |
| tag_t | objectType, | |||
| tag_t | eventType, | |||
| tag_t | subEventType, | |||
| const char * | objectId, | |||
| const char * | objectName, | |||
| const char * | rev, | |||
| int | objectSeq, | |||
| int | secondaryObjectTagCount, | |||
| tag_t * | secondaryObjectTags, | |||
| const char ** | secondaryObjectQualifiers, | |||
| int | paramCount, | |||
| const char ** | paramNames, | |||
| const char ** | paramValues, | |||
| int | errorCode, | |||
| const char * | errorMsg | |||
| ) |
| targetObject | (I) |
| objectType | (I) |
| eventType | (I) |
| subEventType | (I) - optional, this is only used for auditing notification email history. In that case, eventType will be __Email_Send or __Email_Not_send, and subEventType field stores the subscribed event name which triggers the notification email send event. |
| objectId | (I) |
| objectName | (I) |
| rev | (I) |
| objectSeq | (I) |
| secondaryObjectTagCount | (I) |
| secondaryObjectTags | (I) |
| secondaryObjectQualifiers | (I) |
| paramCount | (I) - optional. Count of optional parameters to be recorded |
| paramNames | (I) - optional. Optional parameters to be recorded in audit log |
| paramValues | (I) - optional. Optional parameter values to be recorded in audit log |
| errorCode | (I) - optional. Error code in case of a failure event |
| errorMsg | (I) - optional. Error message in case of a failure event |