Audit Trail Management
Work with activity log file entries is supported by Serena XML. User tasks include:
-
Create Log File Entry - LOG SERVICE CREATE
-
List Activity Log File Entries - LOG SERVICE LIST
Create Log File Entry - LOG SERVICE CREATE
This service posts a date-and-time-stamped entry to the activity log file in order to maintain an audit trail of change activities. All activity log entry types are included in the scope of this function.
The Serena XML service/scope/message names for a request to create a log file entry are:
<service name="LOG">
<scope name="SERVICE">
<message name="CREATE">
These tags appear in both request and reply messages.
LOG SERVICE CREATE — Requests
This functions accepts a free-format text entry for the activity log file of the type identified in the
Exhibit 6-8. LOG SERVICE CREATE <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <logPackage> | Required | 1 | String (10), variable | Package/Application. |
| <logText> | Required | 1 | String (54), variable | Free-format log file entry text. |
| <logType> | Required | 1 | String (2), variable | Log activity type. 01 Backout a Package 02 Install a Package 03 Temporary Change Cycle 04 Distribute a Package 05 Unauthorized Member Access 07 Generate Package Information 08 Delete a Package 09 Generate Application Information 10 Revert a Package 11 Generate Global Information 12 Activate a Component 13 Package Memo Delete 14 Undelete a Package 15 Baseline Ripple 16 Baseline Reverse Ripple 18 Install Package Aged 20 Approve a Package 21 Calendar Re-Synch 22 Staging Libraries Aged 23 Backout A Release 24 Install A Release |
| 25 Distribute a Release 26 Delete a Release 27 Revert a Release 28 Approve a Release 29 Reject a Release 30 Reject a Package 31 Memo Delete a Release 32 Undelete a Release 33 Baseline a Release 34 Install Release Aged 35 Block a Release 36 Unblock a Release 37 Create/Update a Release 40 Freeze a Package 42 Selectively Unfreeze a Package 43 Demote a Component 44 Demote a Package 45 Promote a Release Area 46 Demote a Release Area 48 Promote a Package 49 Promote a Component 50 Audit a Package 51 Alter audit return code 52 Audit a Release Area 53 Approve a Release Area 54 Reject a Release Area 55 Block a Release Area 56 Unblock a Release Area 60 Link a Package 62 Unlink a Package 64 Scratch a Component 66 Rename a Component 68 Component Copied 70 File Tailoring Started 71 File Tailoring Failed 72 File Tailoring Completed 80 Create a Package 81 Checkin Component to Release 82 Checkout a Component 83 Potential Checkout Conflict 84 Stage a Component 85 Overlay Previous Module 86 Delete Module From Package 87 Checkout Component from Release 88 Copy Forward a Package 89 Retrieve Component from Release 90 Monitor Limbo, Internal Scheduler 91 Update Global Release Approvers 92 Update Release Definitions 93 Update Release Applications 94 Attach a Package to a Release 95 Detach a Package from a Release |
LOG SERVICE CREATE — Replies
No <result> data structure is returned in the create log file entry reply message. However, the standard <response> data structure is returned to indicate the success or failure of the checkout request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher.
List Activity Log File Entries - LOG SERVICE LIST
This service requests a list of activity log file entries by activity type, date range, or both. This retrieves an audit trail of change activities. All activity log entry types are included in the scope of this function.
The Serena XML service/scope/message names for a request to list log file entries are:
<service name="LOG">
<scope name="SERVICE">
<message name="LIST">
These tags appear in both request and reply messages.
LOG SERVICE LIST — Requests
Request messages should include either a log file entry type or a date range; otherwise, all log file entries of all types and dates will be returned. If a date range is used, only a starting date is required.
Data structure details appear in Exhibit 6-9.
Exhibit 6-9. LOG SERVICE LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <fromDateStamp> | Optional | 0 - 1 | Date, yyyymmdd | Starting date of log entries desired. NOTE: Need not be paired with ending date if all entries from start date to present are desired. |
| <fromTimeStamp> | Optional | 0 - 1 | Time, HHmmssthtt | Starting time of log entries desired. |
| <logPackage> | Optional | 1 | String (10), variable | Package/Application. |
| <logTypes> | Optional | 0 - 1 | String (150), variable | Semicolon-delimited list of 2 byte activity type codes desired. Type codes are detailed in*Exhibit 6-8 |
| <toDateStamp> | Optional | 0 - 1 | Date, yyyymmdd | Ending date of log entries desired. NOTE: If used, <fromDateStamp> also required. |
This function returns zero to many <result> tags. Each <result> contains a single date-andtime-stamped log file entry.
A standard <response> data structure follows the final <result> tag, if any, to indicate the success or failure of the request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher.
Data structure details for the <result> tag appear in Exhibit 6-10.
Exhibit 6-10. List Activity Log File Entries <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <logDate> | Optional | 0 - 1 | Date, yyyymmdd | Date of activity log entry. |
| <logPackage> | Optional | 1 | String (10), variable | Package/Application. |
| <logText> | Optional | 0 - 1 | String (64), variable | Free-format log file entry text. |
| <logTime> | Optional | 0 - 1 | Time, hhmmss | Time of activity log entry in 24-hour format. |
| <logType> | Optional | 0 - 1 | String (2), variable | Code for type of activity log entry. |
| <user> | Optional | 0 - 1 | String (8), variable | TSO user ID associated with entry. |