Synopsis
Records a message in the Audit Log.
Description
Adds the specified message to the WS_WRK_AUDIT_LOG workflow metadata table, which is referred to as the Audit Log or Audit Trail. A variety of message types are supported such as Information, Warning, and Error that are included in the corresponding message type counts for the task and job. Audit Log messages are accessible via the "Scheduler" tab/window and/or the WS_WRK_AUDIT_LOG table.

Both the Audit Log and Error/Detail Log support similar information and in user-defined custom procedures, either or both logs can be used. However, in RED-generated procedures/scripts, the Audit Log is used for higher-level or summary messages while the Error/Detail Log is used for more detailed supporting information.

Input

Input

Description

Common Input

Includes all 5 inputs of the Callable Routines Common Input.

Audit Message Type Code

Audit Message Type Code:

  • B - Beginning of a Job or Task.
  • I - Information.
  • S - Success.
  • W - Warning.
  • E - Error.
  • F - Fatal Error.

Audit Message Text

Custom message text to be recorded in the WhereScape RED Audit Log.

RDBMS Code

RDBMS-specific message code.

RDBMS Message

RDBMS-specific message.

Output

Output

Description

Result Number

Output Result Number:

  • 1 Success.
  • -3 Error.
  • No labels