To get a full functional sample that implements this component, you can download the sample app and open the module to see how it can be used in a simple CRUD scenario.

Below you will find some guidelines to implement auditing requirement for your applications using this component.

How-to

1 - Add a reference to the service actions from the AuditSystem_OAPI service module that you will need to use for your scenario (for external systems, you can consume the REST endpoints available in AuditSystem_API module).

• AddLogError = Adds an error message log.
• AddLogMessage = Adds a simple general message log.
• AddLogOperationError = Adds an error message log for a transactional operation.
• AddLogOperationSuccess = Adds a success message log for a transactional operation.

* For each action above, there is an asynchronous equivalent one.

2 - Add the audit actions to your entity action wrappers logic.

* For the sake of this sample, the wrappers were created in the end-user module.

3 - For transactional logs (e.g. database operations), serialize the records and add it to the "Record" and/or "RecordOld" parameters, according to the operation type.

4 - Set the Log information by assigning the Headers' attributes of the Request record.

5 - For generic and error messages, add the respective message to the Output parameter. You can also add the JSON of the records to add more detail about the data context in case of log operations.