Synopsis
Records multiple messages in the Audit Log.
Description
Adds the specified multiple messages 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 which 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 theCallable 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(s) Text

Custom message(s) text to be recorded in the WhereScape RED Audit Log. Multiple messages can be specified but each is limited to 256 characters. Each message must be separated by either a new-line (ASCII 10) or tilde (~) character. e.g. Message1~Message2~Message3 will create 3 messages.

RDBMS Code

RDBMS-specific message code. It is optional but recommended to populate this when an error occurs.

RDBMS Message

RDBMS-specific message. It is optional but recommended to populate this when an error occurs.

Output

Output

Description

Result Number

Output Result Number:

  • 1 Success.
  • -2 Error
  • -3 Fatal/Unexpected Error.
  • No labels