Copyright © Cloud Software Group, Inc. All Rights Reserved
Copyright © Cloud Software Group, Inc. All Rights Reserved


Chapter 6 Audit Trails : Create a User-Defined Audit Trail Entry

Create a User-Defined Audit Trail Entry
To create a user-defined entry in the audit trail for a case, enter the following command:
swutil AUDIT [-hostname] procname casenum eventnum desc user [-P priority]
where:
hostname (optional) is the name of the node where the procedure is hosted. If the parameter is omitted, the current node is assumed.
procname is the procedure name, including sub-procedures.
casenum is the case number you want to create the audit trail entry for.
eventnum is the number of the user-defined audit trail entry, as defined in the SWDIR\etc\language.lng\auditusr.mes file. See Defining Audit Trail Entries.
desc and user are text strings which will be displayed in the audit trail entry for the case, in place of the %desc and %user strings, which are defined in the event_description for the entry in the SWDIR\etc\language.lng\auditusr.mes file. See Defining Audit Trail Entries.
The desc and user strings can be used to supply case-specific information, such as a description of the event, the name of the user affected, and any other desired information. The desc string can be a maximum of 24 characters, while user a maximum of 255 characters. If either string includes spaces, it should be enclosed in quotation marks.
-P priority specifies the internal message queue priorities. For more information about message priorities, see "Message Prioritizing" in the appropriate TIBCO iProcess Engine (Database) Administrator’s Guide.
Defining Audit Trail Entries
User-defined audit trail entries must be pre-defined in all of the SWDIR/etc/language.lng/auditusr.mes files. You must create these files if you want to define your own audit trail messages.
System audit trail messages are defined in the SWDIR/etc/language.lng/audit.mes file. You cannot use system audit trail messages with swutil.
User-defined audit trail entries must be defined using the format:
eventnum:event_description
where:
eventnum is the decimal number which identifies the entry, as referenced by the eventnum parameter in the swutil AUDIT command. See Create a User-Defined Audit Trail Entry.
eventnum must be 256 or higher. (Numbers 0 to 255 are reserved for use by iProcess, and are defined in the SWDIR/etc/language.lng/audit.mes file.)
event_description is a message string which describes the event. It can contain the strings %user and %desc, which are replaced by the desc and user strings supplied in the swutil AUDIT command. See Create a User-Defined Audit Trail Entry.

Copyright © Cloud Software Group, Inc. All Rights Reserved
Copyright © Cloud Software Group, Inc. All Rights Reserved