Skip to end of metadata
Go to start of metadata

Cprime Apps has been rebranded as Anova Apps. Please note the only effect is the company name - all of our products’ names, logos, functionalities, support, etc. is exactly the same. The new location to our documentation space is https://anovaapps.atlassian.net.

Availability

This routine is available starting with SIL Engine™ 4.8.0.11.

Syntax

admWriteAuditLog(category, summary, description);

Description

Creates an entry in the system audit log.

Parameters

Parameter name

Type

Required

Description

CategoryStringYes

Category used to filter the audit log entry. Acceptable values:

  • ADVANCED_AUDITING
  • APPLICATIONS
  • AUDITING
  • BOARDS
  • CLUSTERING
  • DASHBOARDS
  • FIELD_CONFIG_SCHEME
  • FIELDS
  • FILTERS
  • GENERAL_CONFIGURATION
  • GROUP_MANAGEMENT
  • INDEXING
  • ISSUE
  • ISSUE_TYPES
  • LOGIN
  • MAIL_SETTINGS
  • MIGRATION
  • NOTIFICATIONS
  • PERMISSIONS
  • PROJECTS
  • SCREENS
  • SEARCH
  • SPRINTS
  • SYSTEM
  • USER_DATA_TRANSFER
  • USER_INTERFACE
  • USER_MANAGEMENT
  • WORKFLOWS
SummaryStringYesA brief description of the audit log entry.
DescriptionStringYesA more detailed account about the nature of the audit log entry.

Return type

Boolean

Returns "true" if operation succeeded.

Example 1

admWriteAuditLog("FIELDS", "Custom field options updated", "The custom field options for field [Field Name] were updated automatically using Power Scripts... In case you were wondering how that happened.");

See also

  • No labels