Copyright © TIBCO Software Inc. All rights reserved.
Copyright © TIBCO Software Inc. All rights reserved.


Appendix B SSOLite Stored Procedures : Command Procedures : SW_AUDIT

SW_AUDIT
The SW_AUDIT procedure instructs the iProcess Engine background (BG) process to create the specified audit trail message for the specified case.
Syntax
SW_AUDIT (
proc_name varchar(8),
proc_maj_ver integer,
proc_min_ver integer,
case_num numeric(20) output,
Audit_id integer
Audit_step varchar(8)
Audit_desc varchar(24)
User_id varchar(255))
where:
proc_name is the name of the procedure that you want to create an audit message for.
proc_maj_ver is either the major version number of the proc_name procedure, or -1. See the notes below.
proc_min_ver is either the minor version number of the proc_name procedure, or -1. See the notes below.
case_num (input) is the name of a variable, defined in the calling program, into which SW_AUDIT will return the case number of the started case. If this information is not required, specify this parameter as 0.
Audit_id is the numeric value of the audit message required. User audit messages will be values greater than 256, as listed in the SWDIR/etc/english.lng/auditusr.mes file. See "Understanding Audit Trails" in TIBCO iProcess Engine Administrator’s Guide for details.
Audit_step is the stepname of this audit. If the step is not required for this audit message, specify this parameter as a null string (‘’) instead.
Audit_desc is the description to be added to the audit message.
User_id is the username that will be added to the audit trail entry.
Notes
Instead of using the specific major and/or minor version number of the procedure, you can specify both the proc_maj_ver and proc_min_ver parameters as -1. If you do this, iProcess will use the version number of the procedure that the case was originally started with or, that it has subsequently been migrated to (if a subsequent version has been released while the case is still in progress).
If you specify one version number parameter as -1, you must specify the other one as -1 as well.
Example
This example creates an audit message 131 for the CARPOOL procedure.

 
EXEC swpro.SW_AUDIT 'CARPOOL', -1, -1, 99999, 131, '', 'BW Activity', 'BW User'

 

Copyright © TIBCO Software Inc. All rights reserved.
Copyright © TIBCO Software Inc. All rights reserved.