$SirJGet: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Place audit trail data on $list<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Place audit trail data on $list<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $SirJGet function is [[ | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $SirJGet function is the [[AppendJournalData (Stringlist function)]].</p> | ||
The $SirJGet function is used to retrieve audit trail data from the current ''Model 204'' journal stream and place it on a $list. $SirJGet is only available if a site has purchased ''[[SirScan]]''. To invoke $SIRJGET, you must have either system manager or system administrator privileges. | The $SirJGet function is used to retrieve audit trail data from the current ''Model 204'' journal stream and place it on a $list. $SirJGet is only available if a site has purchased ''[[SirScan]]''. To invoke $SIRJGET, you must have either system manager or system administrator privileges. | ||
$SirJGet accepts five arguments and returns a numeric code. | $SirJGet accepts five arguments and returns a numeric code. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %RESULT = $SirJGet(list_id, start_time, end_time, | <p class="syntax"><section begin="syntax" /> %RESULT = $SirJGet(list_id, start_time, end_time, | ||
| Line 27: | Line 28: | ||
<td>A list of parameters indicating how the audit trail data is to be formatted. This argument is a list of blank delimited keywords that come from the following list : .sr list = $list .im scanfmt | <td>A list of parameters indicating how the audit trail data is to be formatted. This argument is a list of blank delimited keywords that come from the following list : .sr list = $list .im scanfmt | ||
</td></tr></table> | </td></tr></table> | ||
<p class="code"> | <p class="code"> | ||
0 - No errors | 0 - No errors | ||
| Line 42: | Line 44: | ||
</p> | </p> | ||
The following statement formats all non-stat audit trail entries for IODEV3's between 10 AM and 2 PM on March 12, 1993: | |||
<p class="code"> %RC = $SirJGet(%LIST, '9306310000000', '9306314000000', - | <p class="code"> %RC = $SirJGet(%LIST, '9306310000000', '9306314000000', - | ||
'IODEV3', 'AA') | 'IODEV3', 'AA') | ||
</p> | </p> | ||
<ul> | <ul> | ||
<li>[[SirScan]] | |||
<li> | |||
</ul> | </ul> | ||
<p class="caption">Products authorizing $SirJGet | <p class="caption">Products authorizing $SirJGet | ||
</p> | </p> | ||
[[Category:$Functions|$SirJGet]] | [[Category:$Functions|$SirJGet]] | ||
Revision as of 18:29, 8 February 2011
<section begin="desc" />Place audit trail data on $list<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $SirJGet function is the AppendJournalData (Stringlist function).
The $SirJGet function is used to retrieve audit trail data from the current Model 204 journal stream and place it on a $list. $SirJGet is only available if a site has purchased SirScan. To invoke $SIRJGET, you must have either system manager or system administrator privileges.
$SirJGet accepts five arguments and returns a numeric code.
Syntax
<section begin="syntax" /> %RESULT = $SirJGet(list_id, start_time, end_time, user_list, parms) <section end="syntax" />
$SirJGet Function
%RESULT is set to indicate the success of the function.
| list_id | The identifier of the $list that is to receive the formatted audit trail data. The audit trail data is appended to the current contents of the indicated $list. This is a required argument. |
|---|---|
| start_time | The start time for the journal data to be formatted in YYDDDHHMISSXX format (YY = year, DDD = Julian day number, HH = hour, MI = minutes, SS = seconds, XX = hundredths of seconds). This start time is inclusive, so any audit trail entry matching the specified start time is considered to be in the range. If start_time is not specified, the start time is considered to be the time that the Model 204 region was brought up. |
| end_time | The end time for the journal data to be formatted in YYDDDHHMISSXX format (YY = year, DDD = Julian day number, HH = hour, MI = minutes, SS = seconds, XX = hundredths of seconds). This end time is exclusive, so any audit trail entry matching the specified end time is considered to be out of the range, and is not formatted. If end_time is not specified, the end time is considered to be the current time. |
| user_list | Selection criteria for users for which audit trail data is to be formatted. .im scansel |
| parms | A list of parameters indicating how the audit trail data is to be formatted. This argument is a list of blank delimited keywords that come from the following list : .sr list = $list .im scanfmt |
0 - No errors 1 - MAXREC exceeded ($list might contain new records) 2 - MAXIO exceeded ($list might contain new records) 3 - CCATEMP full (if LISTFC $SirParm parameter not set) 4 - Out of virtual storage 6 - $List identifier missing 7 - Invalid $list identifier 8 - Invalid parameter (argument 5) 9 - Invalid start or end time (argument 2 or 3) 10 - No audit trail types selected (ST, AA, AD, etc..)
$SirJGet return codes
The following statement formats all non-stat audit trail entries for IODEV3's between 10 AM and 2 PM on March 12, 1993:
%RC = $SirJGet(%LIST, '9306310000000', '9306314000000', - 'IODEV3', 'AA')
Products authorizing $SirJGet