AppendJournalData (Stringlist function) - Revision history

ELowell at 23:20, 2 September 2015

2015-09-02T23:20:01Z

← Older revision		Revision as of 23:20, 2 September 2015
Line 1:		Line 1:
	{{Template:Stringlist:AppendJournalData subtitle}}		{{Template:Stringlist:AppendJournalData subtitle}}

	This [[Notation conventions for methods#Callable functions\|callable]] method adds lines to the end of a <var>Stringlist</var> from the current, or a specified, <var class="product">Model 204</var> journal. The <var>AppendJournalData</var> method is only available to customers licensed for <var class="product">[[SirScan]]</var>.		This [[Notation conventions for methods#Callable functions\|callable]] method adds lines to the end of a <var>Stringlist</var> from the current, or a specified, <var class="product">Model 204</var> journal. The <var>AppendJournalData</var> method is only available to customers licensed for <var class="product">[[SirScan]]</var>.

ELowell: /* Examples */

2015-09-02T23:19:32Z

Examples

← Older revision		Revision as of 23:19, 2 September 2015
Line 192:		Line 192:
	options = 'AA')		options = 'AA')
	</p>		</p>


	</ol>		</ol>

	==See also==		==See also==
	{{Template:Stringlist:AppendJournalData footer}}		{{Template:Stringlist:AppendJournalData footer}}

JAL: remove Sys Man guide

2014-10-30T19:02:15Z

remove Sys Man guide

Show changes

ELowell: /* Options parameter */

2014-10-29T22:01:53Z

Options parameter

← Older revision		Revision as of 22:01, 29 October 2014
Line 96:		Line 96:
	<tr><th><var>OI</var></th><td>OI type entries are to be formatted.</td></tr>		<tr><th><var>OI</var></th><td>OI type entries are to be formatted.</td></tr>
	<tr><th><var>OO</var></th><td>OO type entries are to be formatted.</td></tr>		<tr><th><var>OO</var></th><td>OO type entries are to be formatted.</td></tr>
	<tr><th><var>QT</var></th><td>QT type entries are to be formatted. ~~This option first became~~ available ~~with~~ version 7.5 of <var class="product">Model 204</var>.</td></tr>		<tr><th><var>QT</var></th><td>QT type entries are to be formatted. QT is available as of version 7.5 of <var class="product">Model 204</var>.</td></tr>
	<tr><th><var>RK</var></th><td>RK type entries are to be formatted.</td></tr>		<tr><th><var>RK</var></th><td>RK type entries are to be formatted.</td></tr>
	<tr><th><var>SEQ</var></th><td>Each output <var>Stringlist</var> item is to contain an eight-byte sequence number at the start. The SEQ parameter is followed by the starting sequence number and an an increment separated by a comma, as in <code>SEQ=100,5</code>, which means that the starting sequence number is 100, and the sequence numbers increment by 5. Note that the starting sequence number never actually appears, because the first <var>Stringlist</var> item causes it to be incremented. In the previous example, the first added <var>Stringlist</var> item would actually be 105. The starting sequence number can be omitted, in which case it is assumed to be 0, so <code>SEQ=,1</code> causes sequence numbers to start at one and go up by one. The sequence numbers are always eight bytes long and padded on the left with zeros. If the sequence number exceeds 99999999, the leading decimal digits are simply discarded.</td></tr>		<tr><th><var>SEQ</var></th><td>Each output <var>Stringlist</var> item is to contain an eight-byte sequence number at the start. The SEQ parameter is followed by the starting sequence number and an an increment separated by a comma, as in <code>SEQ=100,5</code>, which means that the starting sequence number is 100, and the sequence numbers increment by 5. Note that the starting sequence number never actually appears, because the first <var>Stringlist</var> item causes it to be incremented. In the previous example, the first added <var>Stringlist</var> item would actually be 105. The starting sequence number can be omitted, in which case it is assumed to be 0, so <code>SEQ=,1</code> causes sequence numbers to start at one and go up by one. The sequence numbers are always eight bytes long and padded on the left with zeros. If the sequence number exceeds 99999999, the leading decimal digits are simply discarded.</td></tr>

Dme: /* Options parameter */

2013-05-24T16:28:41Z

Options parameter

← Older revision		Revision as of 16:28, 24 May 2013
Line 96:		Line 96:
	<tr><th><var>OI</var></th><td>OI type entries are to be formatted.</td></tr>		<tr><th><var>OI</var></th><td>OI type entries are to be formatted.</td></tr>
	<tr><th><var>OO</var></th><td>OO type entries are to be formatted.</td></tr>		<tr><th><var>OO</var></th><td>OO type entries are to be formatted.</td></tr>
	<tr><th><var>QT</var></th><td>QT type entries are to be formatted.</td></tr>		<tr><th><var>QT</var></th><td>QT type entries are to be formatted. This option first became available with version 7.5 of <var class="product">Model 204</var>.</td></tr>
	<tr><th><var>RK</var></th><td>RK type entries are to be formatted.</td></tr>		<tr><th><var>RK</var></th><td>RK type entries are to be formatted.</td></tr>
	<tr><th><var>SEQ</var></th><td>Each output <var>Stringlist</var> item is to contain an eight-byte sequence number at the start. The SEQ parameter is followed by the starting sequence number and an an increment separated by a comma, as in <code>SEQ=100,5</code>, which means that the starting sequence number is 100, and the sequence numbers increment by 5. Note that the starting sequence number never actually appears, because the first <var>Stringlist</var> item causes it to be incremented. In the previous example, the first added <var>Stringlist</var> item would actually be 105. The starting sequence number can be omitted, in which case it is assumed to be 0, so <code>SEQ=,1</code> causes sequence numbers to start at one and go up by one. The sequence numbers are always eight bytes long and padded on the left with zeros. If the sequence number exceeds 99999999, the leading decimal digits are simply discarded.</td></tr>		<tr><th><var>SEQ</var></th><td>Each output <var>Stringlist</var> item is to contain an eight-byte sequence number at the start. The SEQ parameter is followed by the starting sequence number and an an increment separated by a comma, as in <code>SEQ=100,5</code>, which means that the starting sequence number is 100, and the sequence numbers increment by 5. Note that the starting sequence number never actually appears, because the first <var>Stringlist</var> item causes it to be incremented. In the previous example, the first added <var>Stringlist</var> item would actually be 105. The starting sequence number can be omitted, in which case it is assumed to be 0, so <code>SEQ=,1</code> causes sequence numbers to start at one and go up by one. The sequence numbers are always eight bytes long and padded on the left with zeros. If the sequence number exceeds 99999999, the leading decimal digits are simply discarded.</td></tr>

Dme: /* Options parameter */

2013-04-05T17:54:19Z

Options parameter

← Older revision		Revision as of 17:54, 5 April 2013
Line 96:		Line 96:
	<tr><th><var>OI</var></th><td>OI type entries are to be formatted.</td></tr>		<tr><th><var>OI</var></th><td>OI type entries are to be formatted.</td></tr>
	<tr><th><var>OO</var></th><td>OO type entries are to be formatted.</td></tr>		<tr><th><var>OO</var></th><td>OO type entries are to be formatted.</td></tr>
			<tr><th><var>QT</var></th><td>QT type entries are to be formatted.</td></tr>
	<tr><th><var>RK</var></th><td>RK type entries are to be formatted.</td></tr>		<tr><th><var>RK</var></th><td>RK type entries are to be formatted.</td></tr>
	<tr><th><var>SEQ</var></th><td>Each output <var>Stringlist</var> item is to contain an eight-byte sequence number at the start. The SEQ parameter is followed by the starting sequence number and an an increment separated by a comma, as in <code>SEQ=100,5</code>, which means that the starting sequence number is 100, and the sequence numbers increment by 5. Note that the starting sequence number never actually appears, because the first <var>Stringlist</var> item causes it to be incremented. In the previous example, the first added <var>Stringlist</var> item would actually be 105. The starting sequence number can be omitted, in which case it is assumed to be 0, so <code>SEQ=,1</code> causes sequence numbers to start at one and go up by one. The sequence numbers are always eight bytes long and padded on the left with zeros. If the sequence number exceeds 99999999, the leading decimal digits are simply discarded.</td></tr>		<tr><th><var>SEQ</var></th><td>Each output <var>Stringlist</var> item is to contain an eight-byte sequence number at the start. The SEQ parameter is followed by the starting sequence number and an an increment separated by a comma, as in <code>SEQ=100,5</code>, which means that the starting sequence number is 100, and the sequence numbers increment by 5. Note that the starting sequence number never actually appears, because the first <var>Stringlist</var> item causes it to be incremented. In the previous example, the first added <var>Stringlist</var> item would actually be 105. The starting sequence number can be omitted, in which case it is assumed to be 0, so <code>SEQ=,1</code> causes sequence numbers to start at one and go up by one. The sequence numbers are always eight bytes long and padded on the left with zeros. If the sequence number exceeds 99999999, the leading decimal digits are simply discarded.</td></tr>

Dme: /* Syntax terms */

2013-04-04T01:52:50Z

Syntax terms

← Older revision		Revision as of 01:52, 4 April 2013
Line 23:		Line 23:
	<td>A <var>Stringlist</var> object.</td></tr>		<td>A <var>Stringlist</var> object.</td></tr>
	<tr><th><var>StartTime</var></th>		<tr><th><var>StartTime</var></th>
	<td>The first positional parameter, optionally named <var>StartTime</var>, is a string containing the time of the first journal entry to be processed. The time in the string should be 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. Specifying this parameter is optional; if it is not specified, the start time is considered to be the time that the <var class="product">Model 204</var> region was brought up.</td></tr>		<td>The first positional parameter, optionally named <var>StartTime</var>, is a string containing the time of the first journal entry to be processed. The time in the string should be 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. Specifying this parameter is optional; if it is not specified, the start time is considered to be the time that the <var class="product">Model 204</var> region was brought up. All of the [[#Examples\|examples below]] employ the <var>StartTime</var> parameter; [[#relTime\|one of them]] demonstrates using a time relative to the current time.</td></tr>
	<tr><th><var>EndTime</var></th>		<tr><th><var>EndTime</var></th>
	<td>The second positional parameter, optionally named <var>EndTime</var>, is a string containing the end time of the first journal entry to be processed. The time in the string should be 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. Specifying this parameter is optional; if it is not specified, the end time is considered to be the current time.</td></tr>		<td>The second positional parameter, optionally named <var>EndTime</var>, is a string containing the end time of the first journal entry to be processed. The time in the string should be 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. Specifying this parameter is optional; if it is not specified, the end time is considered to be the current time.</td></tr>

Dme: /* Examples */

2013-04-04T01:48:57Z

Examples

@@ Line 132: / Line 132: @@
 %list:appendJournalData('0922210000000', '0922214000000', -
     'IODEV3', 'AA', 'OLDJRNL')
-</p></ol>
+</p>
 ==See also==
 {{Template:Stringlist:AppendJournalData footer}}

Admin: /* Usage notes */

2012-10-10T20:21:27Z

Usage notes

← Older revision		Revision as of 20:21, 10 October 2012
Line 110:		Line 110:
	==Usage notes==		==Usage notes==
	<ul><li>If the caller of <var>AppendJournalData</var> is not a System Administrator, an implicit selection filter is applied so that the caller will only see entries that were produced by a thread with the same userid as the caller. This condition is ANDed with any other filtering conditions.<br>In the case of a historical journal (that is, a journal produced by a run other than the current run), the user must instantiate a <var>Journal</var> class object that references a stream. When that stream is opened, <var class="product">Model 204</var> ensures that the current user has Read access to the dataset(s) comprising the stream. A user whose security (ACF2, RACF etc) profile does not allow Read access is not allowed to issue the <var>AppendJournalData</var> method for that journal.		<ul><li>If the caller of <var>AppendJournalData</var> is not a System Administrator, an implicit selection filter is applied so that the caller will only see entries that were produced by a thread with the same userid as the caller. This condition is ANDed with any other filtering conditions.<br>In the case of a historical journal (that is, a journal produced by a run other than the current run), the user must instantiate a <var>Journal</var> class object that references a stream. When that stream is opened, <var class="product">Model 204</var> ensures that the current user has Read access to the dataset(s) comprising the stream. A user whose security (ACF2, RACF etc) profile does not allow Read access is not allowed to issue the <var>AppendJournalData</var> method for that journal.
	<li>If you want to use a journal other than the current one, its dataset(s) have to be allocated to your Online. You may need to use the <var class="product">Model 204</var> ALLOCATE or DEFINE STREAM commands, both of which are described in the <~~var class="product"~~>Model 204 System Manager's Guide</~~var~~> and/or the <~~var class="product"~~>Model 204 Command Reference ~~Manual~~</~~var~~>.		<li>If you want to use a journal other than the current one, its dataset(s) have to be allocated to your Online. You may need to use the <var class="product">Model 204</var> ALLOCATE or DEFINE STREAM commands, both of which are described in the <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-System-Mgr/view Rocket Model 204 System Manager's Guide]</i> and/or the <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-Command-Ref/view Rocket Model 204 Parameter and Command Reference]</i>.
	<li>Under <var class=product>Sirius Mods</var> Version 7.7, if you specify a journal other than the current one, it must be a journal created with the same <var class="product">Model 204</var> release as your current Online. If the releases are different, any <var>AppendJournalData</var> method call will silently fail to add any data to its output <var>Stringlist</var>. In <var class=product>Sirius Mods</var> Version 7.8, an attempt to instantiate a <var>Journal</var> object variable that references a journal from a different version than the Online produces a <var>BadJournal</var> exception.</ul>		<li>Under <var class=product>Sirius Mods</var> Version 7.7, if you specify a journal other than the current one, it must be a journal created with the same <var class="product">Model 204</var> release as your current Online. If the releases are different, any <var>AppendJournalData</var> method call will silently fail to add any data to its output <var>Stringlist</var>. In <var class=product>Sirius Mods</var> Version 7.8, an attempt to instantiate a <var>Journal</var> object variable that references a journal from a different version than the Online produces a <var>BadJournal</var> exception.</ul>

Admin: /* Usage notes */

2012-10-10T20:07:00Z

Usage notes

← Older revision		Revision as of 20:07, 10 October 2012
Line 109:		Line 109:

	==Usage notes==		==Usage notes==
	<ul><li>If the caller of <var>AppendJournalData</var> is not a System Administrator, an implicit selection filter is applied so that the caller will only see entries that were produced by a thread with the same userid as the caller. This condition is ANDed with any other filtering conditions.<br>In the case of a historical journal (that is, a journal produced by a run other than the current run), the user must instantiate a <var>[[Journal ~~class]]~~</var> object that references a stream. When that stream is opened, <var class="product">Model 204</var> ensures that the current user has Read access to the dataset(s) comprising the stream. A user whose security (ACF2, RACF etc) profile does not allow Read access is not allowed to issue the <var>AppendJournalData</var> method for that journal.		<ul><li>If the caller of <var>AppendJournalData</var> is not a System Administrator, an implicit selection filter is applied so that the caller will only see entries that were produced by a thread with the same userid as the caller. This condition is ANDed with any other filtering conditions.<br>In the case of a historical journal (that is, a journal produced by a run other than the current run), the user must instantiate a <var>Journal</var> class object that references a stream. When that stream is opened, <var class="product">Model 204</var> ensures that the current user has Read access to the dataset(s) comprising the stream. A user whose security (ACF2, RACF etc) profile does not allow Read access is not allowed to issue the <var>AppendJournalData</var> method for that journal.
	<li>If you want to use a journal other than the current one, its dataset(s) have to be allocated to your Online. You may need to use the <var class="product">Model 204</var> ALLOCATE or DEFINE STREAM commands, both of which are described in the <var class="product">Model 204 System Manager's Guide</var> and/or the <var class="product">Model 204 Command Reference Manual</var>.		<li>If you want to use a journal other than the current one, its dataset(s) have to be allocated to your Online. You may need to use the <var class="product">Model 204</var> ALLOCATE or DEFINE STREAM commands, both of which are described in the <var class="product">Model 204 System Manager's Guide</var> and/or the <var class="product">Model 204 Command Reference Manual</var>.
	<li>Under <var class=product>Sirius Mods</var> Version 7.7, if you specify a journal other than the current one, it must be a journal created with the same <var class="product">Model 204</var> release as your current Online. If the releases are different, any <var>AppendJournalData</var> method call will silently fail to add any data to its output <var>Stringlist</var>. In <var class=product>Sirius Mods</var> Version 7.8, an attempt to instantiate a <var>Journal</var> object variable that references a journal from a different version than the Online produces a <var>BadJournal</var> exception.</ul>		<li>Under <var class=product>Sirius Mods</var> Version 7.7, if you specify a journal other than the current one, it must be a journal created with the same <var class="product">Model 204</var> release as your current Online. If the releases are different, any <var>AppendJournalData</var> method call will silently fail to add any data to its output <var>Stringlist</var>. In <var class=product>Sirius Mods</var> Version 7.8, an attempt to instantiate a <var>Journal</var> object variable that references a journal from a different version than the Online produces a <var>BadJournal</var> exception.</ul>

	==Examples==		==Examples==
	<ol><li>The following method invocation formats all non-stat audit trail entries for IODEV3 types between 10 a.m. and 2 p.m. on August 10, 2009 from the OLDJRNL historical journal:		<ol><li>The following method invocation formats all non-stat audit trail entries for IODEV3 types between 10 a.m. and 2 p.m. on August 10, 2009 from the OLDJRNL historical journal: