Session.LogAuditMessage(Text, SecurityOperationResult, AuditCategory, Integer, Integer [, Dictionary of [Text, Text]]) Method

  • Article

Version: Available or changed with runtime version 13.1.

Logs a message to an audit account. Note, these logs are accessible to customers and will also be logged to a security audit account.

Note

This method is supported only in Business Central on-premises.

Syntax

 Session.LogAuditMessage(SecurityAuditDescription: Text, SecurityAuditOperationResult: SecurityOperationResult, SecurityAuditCategory: AuditCategory, AuditMessageOperation: Integer, AuditMessageOperationResult: Integer [, CustomDimensions: Dictionary of [Text, Text]])

Note

This method can be invoked without specifying the data type name.

Parameters

SecurityAuditDescription
 Type: Text
The description for the security audit message.

SecurityAuditOperationResult
 Type: SecurityOperationResult
The operation result for the security audit message.

SecurityAuditCategory
 Type: AuditCategory
The category of the operation for the security audit message.

AuditMessageOperation
 Type: Integer
The operation type for the audit message. Specify one of the following values:

  • 0: AdministeredEnvironment.
  • 1: ConfiguredExtension.
  • 2: AdministeredUser.
  • 3: AdministeredCompany.
  • 4: ConfiguredIntegration.
  • 5: ConfiguredCopilot.
  • 6: ConfiguredCloudMigration.
  • 7: AdministeredReport.

AuditMessageOperationResult
 Type: Integer
The operation result for the audit message. Specify one of the following values:

  • 0: Succeeded.
  • 1: PartiallySucceeded.
  • 2: Failed.

[Optional] CustomDimensions
 Type: Dictionary of [Text, Text]
Set of additional dimensions, specified as a dictionary, that will be emitted to the telemetry account and that can be used to specify filters in the query.

Session Data Type
Getting Started with AL
Developing Extensions