IMAGINE command - Revision history

Alex: Nest syntax, example, and usage notes under SYNC/EXTRACT

2026-06-04T21:29:54Z

Nest syntax, example, and usage notes under SYNC/EXTRACT

@@ Line 28: / Line 28: @@
 </ul>
-==IMAGINE ENDSYNC==
+===Syntax notes===
 <p>
    The IMAGINE command operates on the context file which is either the current file or one
@@ Line 66: / Line 36: @@
 </p>
-==Example==
+===Example===
 <p>
    To put file FOO into sync mode, one can do:
@@ Line 83: / Line 53: @@
 for errors, should they occur.
 </p>
-==Usage notes==
+===Usage notes===
 <p>
    To obtain a consistent view of the file on <var>Imagine</var>, the IMAGINE command
@@ Line 123: / Line 93: @@
    command where updates to the file had been quiesced.
 </p>
 ==See also==

Alex: Separate IMAGINE command formats into sections

2026-06-04T21:25:02Z

Separate IMAGINE command formats into sections

← Older revision		Revision as of 21:25, 4 June 2026
Line 12:		Line 12:
	</dl>		</dl>

	==~~Syntax for~~ IMAGINE==		==IMAGINE SYNC and IMAGINE EXTRACT==
	<p class="syntax">IMAGINE SYNC \| EXTRACT [ASYNC] [MAXERR e] [MAXPENDING m] [RECORDNUMBER r] [NOCOMMIT] [TICK t]		<p class="syntax">IMAGINE SYNC \| EXTRACT [ASYNC] [MAXERR e] [MAXPENDING m] [RECORDNUMBER r] [NOCOMMIT] [TICK t]
	</p>		</p>
Line 28:		Line 28:
	</ul>		</ul>

	~~There is also a format of the~~ IMAGINE ~~command:~~		==IMAGINE ENDSYNC==
	<p class="syntax">IMAGINE ENDSYNC		<p class="syntax">IMAGINE ENDSYNC
	</p>		</p>

	~~That~~ indicates a SYNC or EXTRACT for the file should be terminated.		This format indicates that a SYNC or EXTRACT for the file should be terminated.

	~~There is also a format of the~~ IMAGINE ~~command:~~		==IMAGINE LISTSYNC==
	<p class="syntax">IMAGINE LISTSYNC		<p class="syntax">IMAGINE LISTSYNC
	</p>		</p>

	~~That~~ lists the files currently in SYNC mode. For each such file, a row is printed		This format lists the files currently in SYNC mode. For each such file, a row is
	with the following columns:		printed with the following columns:
	<ul>		<ul>
	<li><var class="term">FILE</var> — the <var>Model 204</var> file name.</li>		<li><var class="term">FILE</var> — the <var>Model 204</var> file name.</li>
Line 58:		Line 58:
	context file.		context file.

	===Syntax notes===		==Syntax notes==
	<p>		<p>
	The IMAGINE command operates on the context file which is either the current file or one		The IMAGINE command operates on the context file which is either the current file or one

Alex: Document IMAGINE LISTSYNC subcommand (PDS-9088)

2026-05-29T17:14:22Z

Document IMAGINE LISTSYNC subcommand (PDS-9088)

← Older revision		Revision as of 17:14, 29 May 2026
Line 33:		Line 33:

	That indicates a SYNC or EXTRACT for the file should be terminated.		That indicates a SYNC or EXTRACT for the file should be terminated.

			There is also a format of the IMAGINE command:
			<p class="syntax">IMAGINE LISTSYNC
			</p>

			That lists the files currently in SYNC mode. For each such file, a row is printed
			with the following columns:
			<ul>
			<li><var class="term">FILE</var> — the <var>Model 204</var> file name.</li>
			<li><var class="term">SFX</var> — the broker suffix being used for the file's sync
			traffic (the value supplied via <var>APSYSUFFIX</var> when the file was put into
			sync mode), or <code>-</code> if no suffix is in use.</li>
			<li><var class="term">START</var> — the time at which the <code>IMAGINE SYNC</code>
			command was issued for the file, formatted as <code>YYYYMMDDHHMISS</code>.</li>
			<li><var class="term">END</var> — the time at which the extract phase completed,
			formatted as <code>YYYYMMDDHHMISS</code>. Blank if the extract is still running.</li>
			<li><var class="term">UPDATES</var> — the number of post-extract sync updates that
			have been sent to <var>Imagine</var> for the file. The counter is zeroed when the
			extract phase completes, so this value reflects only ongoing sync traffic, not the
			records sent during the initial extract.</li>
			</ul>

			<var>IMAGINE LISTSYNC</var> takes no parameters and is independent of the current
			context file.

	===Syntax notes===		===Syntax notes===

Alex: /* Syntax for IMAGINE */

2025-07-30T10:52:54Z

Syntax for IMAGINE

← Older revision		Revision as of 10:52, 30 July 2025
Line 13:		Line 13:

	==Syntax for IMAGINE==		==Syntax for IMAGINE==
	<p class="syntax">IMAGINE SYNC \| EXTRACT [~~NOCOMMIT~~] [~~TICK t~~] [MAXPENDING m] [~~MAXERR e~~] [~~ASYNC~~]		<p class="syntax">IMAGINE SYNC \| EXTRACT [ASYNC] [MAXERR e] [MAXPENDING m] [RECORDNUMBER r] [NOCOMMIT] [TICK t]
	</p>		</p>

Line 20:		Line 20:
	<li><var class="term">SYNC</var> indicates that data is to be extracted and the <var>Model 204</var> file and <var>Imagine</var> are to be kept in sync after the command.</li>		<li><var class="term">SYNC</var> indicates that data is to be extracted and the <var>Model 204</var> file and <var>Imagine</var> are to be kept in sync after the command.</li>
	<li><var class="term">EXTRACT</var> indicates that data is to be extracted but the <var>Model 204</var> file and <var>Imagine</var> are not to be kept in sync after the command.</li>		<li><var class="term">EXTRACT</var> indicates that data is to be extracted but the <var>Model 204</var> file and <var>Imagine</var> are not to be kept in sync after the command.</li>
	<li><var class="term">NOCOMMIT</var> indicates that the data is to be sent to Imagine and processed, but not committed. This provides a way of validating that a file can be loaded into <var>Imagine</var> without actually doing so. This option makes no sense for a SYNC extract so is only allowed with <code>IMAGINE EXTRACT</code>.</li>		<li><var class="term">ASYNC</var> indicates that the actual extract is to be performed on a daemon. In this mode, the command returns immediately after some preliminary setup. The advantage of this mode is that it frees up the issuing thread for other commands. The disadvantage is that one must look elsewhere to determine when the request completed and whether or not it was successful.</li>
			<li><var class="term">MAXERR</var> indicates the maximum number of record data errors allowed before the extract is aborted. One might wish to set this to a high value for an extract intended to scan a file for data integrity errors. Because records are sent asynchronously in batches, it's quite possible for the actual number of errors to exceed the <var>MAXERROR</var> value. <var>MAXERROR</var> defaults to 50.</li>
			<li><var class="term">MAXPENDING</var> indicates the maximum number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>
			<li><var class="term">NOCOMMIT</var> indicates that the data is to be sent to Imagine and processed, but not committed. This provides a way of validating that a file can be loaded into <var>Imagine</var> without actually doing so. This option makes no sense for a SYNC extract, so is only allowed with <code>IMAGINE EXTRACT</code>.</li>
			<li><var class="term">RECORDNUMBER</var> indicates the record number of the single record to be sent to Imagine. This might be useful for problem diagnosis or resending fixed up records that failed on an initial extract. This option makes no sense for a SYNC extract so is only allowed with <code>IMAGINE EXTRACT</code>. Other options (except <var>NOCOMMIT</var>) are ignored if <var>RECORDNUMBER</var> is specified.</li>
	<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>		<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>
	<li><var class="term">MAXPENDING</var> indicates the maximum number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>
	<li><var class="term">MAXERR</var> indicates the maximum number of record data errors allowed before the extract is aborted. One might wish to set this to a high value for an extract intended to scan a file for data integrity errors. Because records are sent asynchronously in batches, it's quite possible for the actual number of errors to exceed the <var>MAXERROR</var> value. <var>MAXERROR</var> defaults to 50.</li>
	<li><var class="term">ASYNC</var> indicates that the actual extract is to be performed on a daemon. In this mode, the command returns immediately after some preliminary setup. The advantage of this mode is that it frees up the issuing thread for other commands. The disadvantage is that one must look elsewhere to determine when the request completed and whether or not it was successful.</li>
	</ul>		</ul>

Alex: /* Syntax for IMAGINE */

2025-07-09T14:29:56Z

Syntax for IMAGINE

← Older revision		Revision as of 14:29, 9 July 2025
Line 13:		Line 13:

	==Syntax for IMAGINE==		==Syntax for IMAGINE==
	<p class="syntax">IMAGINE SYNC \| EXTRACT [NOCOMMIT] [TICK t] [MAXPENDING m] [MAXERR e]		<p class="syntax">IMAGINE SYNC \| EXTRACT [NOCOMMIT] [TICK t] [MAXPENDING m] [MAXERR e] [ASYNC]
	</p>		</p>

Line 24:		Line 24:
	<li><var class="term">MAXPENDING</var> indicates the maximum number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>		<li><var class="term">MAXPENDING</var> indicates the maximum number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>
	<li><var class="term">MAXERR</var> indicates the maximum number of record data errors allowed before the extract is aborted. One might wish to set this to a high value for an extract intended to scan a file for data integrity errors. Because records are sent asynchronously in batches, it's quite possible for the actual number of errors to exceed the <var>MAXERROR</var> value. <var>MAXERROR</var> defaults to 50.</li>		<li><var class="term">MAXERR</var> indicates the maximum number of record data errors allowed before the extract is aborted. One might wish to set this to a high value for an extract intended to scan a file for data integrity errors. Because records are sent asynchronously in batches, it's quite possible for the actual number of errors to exceed the <var>MAXERROR</var> value. <var>MAXERROR</var> defaults to 50.</li>
			<li><var class="term">ASYNC</var> indicates that the actual extract is to be performed on a daemon. In this mode, the command returns immediately after some preliminary setup. The advantage of this mode is that it frees up the issuing thread for other commands. The disadvantage is that one must look elsewhere to determine when the request completed and whether or not it was successful.</li>
	</ul>		</ul>

Alex at 23:37, 4 June 2025

2025-06-04T23:37:55Z

← Older revision		Revision as of 23:37, 4 June 2025
Line 13:		Line 13:

	==Syntax for IMAGINE==		==Syntax for IMAGINE==
	<p class="syntax">IMAGINE SYNC \| EXTRACT [NOCOMMIT] [TICK t] [MAXPENDING m]		<p class="syntax">IMAGINE SYNC \| EXTRACT [NOCOMMIT] [TICK t] [MAXPENDING m] [MAXERR e]
	</p>		</p>

Line 23:		Line 23:
	<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>		<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>
	<li><var class="term">MAXPENDING</var> indicates the maximum number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>		<li><var class="term">MAXPENDING</var> indicates the maximum number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>
			<li><var class="term">MAXERR</var> indicates the maximum number of record data errors allowed before the extract is aborted. One might wish to set this to a high value for an extract intended to scan a file for data integrity errors. Because records are sent asynchronously in batches, it's quite possible for the actual number of errors to exceed the <var>MAXERROR</var> value. <var>MAXERROR</var> defaults to 50.</li>
	</ul>		</ul>

Alex: /* Syntax for IMAGINE */

2025-05-02T14:07:27Z

Syntax for IMAGINE

← Older revision		Revision as of 14:07, 2 May 2025
Line 20:		Line 20:
	<li><var class="term">SYNC</var> indicates that data is to be extracted and the <var>Model 204</var> file and <var>Imagine</var> are to be kept in sync after the command.</li>		<li><var class="term">SYNC</var> indicates that data is to be extracted and the <var>Model 204</var> file and <var>Imagine</var> are to be kept in sync after the command.</li>
	<li><var class="term">EXTRACT</var> indicates that data is to be extracted but the <var>Model 204</var> file and <var>Imagine</var> are not to be kept in sync after the command.</li>		<li><var class="term">EXTRACT</var> indicates that data is to be extracted but the <var>Model 204</var> file and <var>Imagine</var> are not to be kept in sync after the command.</li>
	<li><var class="term">NOCOMMIT</var> indicates that the data is to be sent to Imagine and processed, but not committed. This provides a way of validating that a file can be loaded into <var>Imagine</var> without actually doing so.</li>		<li><var class="term">NOCOMMIT</var> indicates that the data is to be sent to Imagine and processed, but not committed. This provides a way of validating that a file can be loaded into <var>Imagine</var> without actually doing so. This option makes no sense for a SYNC extract so is only allowed with <code>IMAGINE EXTRACT</code>.</li>
	<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>		<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>
	<li><var class="term">MAXPENDING</var> indicates the maximum number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>		<li><var class="term">MAXPENDING</var> indicates the maximum number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>
Line 38:		Line 38:
	<p class="code">IN FILE FOOBAR EXTRACT NOCOMMIT		<p class="code">IN FILE FOOBAR EXTRACT NOCOMMIT
	</p>		</p>


	==Example==		==Example==

Alex at 11:30, 2 May 2025

2025-05-02T11:30:21Z

@@ Line 22: / Line 22: @@
 <li><var class="term">NOCOMMIT</var> indicates that the data is to be sent to Imagine and processed, but not committed. This provides a way of validating that a file can be loaded into <var>Imagine</var> without actually doing so.</li>
 <li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>
-<li><var class="term">MAXPENDING</var> indicates the maximu number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>
+<li><var class="term">MAXPENDING</var> indicates the maximum number of uncommitted record sends to be allowed in the extract. Setting this to a low value could result in reduced transfer rates because of network latency. <var>MAXPENDING</var> defaults to 4095.</li>
 </ul>
@@ Line 32: / Line 32: @@
 ===Syntax notes===
 ==Example==
 ==Usage notes==
 ==See also==
 [[Category: File manager commands]]
 [[Category:Commands]]

Alex: /* Syntax for IMAGINE */

2025-05-02T10:47:13Z

Syntax for IMAGINE

← Older revision		Revision as of 10:47, 2 May 2025
Line 19:		Line 19:
	<ul>		<ul>
	<li><var class="term">SYNC</var> indicates that data is to be extracted and the <var>Model 204</var> file and <var>Imagine</var> are to be kept in sync after the command.</li>		<li><var class="term">SYNC</var> indicates that data is to be extracted and the <var>Model 204</var> file and <var>Imagine</var> are to be kept in sync after the command.</li>
	<li><var class="term">EXTRACT/var> indicates that data is to be extracted but the <var>Model 204</var> file and <var>Imagine</var> are not to be kept in sync after the command.</li>		<li><var class="term">EXTRACT</var> indicates that data is to be extracted but the <var>Model 204</var> file and <var>Imagine</var> are not to be kept in sync after the command.</li>
	<li><var class="term">NOCOMMIT</var> indicates that the data is to be sent to Imagine and processed, but not committed. This provides a way of validating that a file can be loaded into <var>Imagine</var> without actually doing so.</li>		<li><var class="term">NOCOMMIT</var> indicates that the data is to be sent to Imagine and processed, but not committed. This provides a way of validating that a file can be loaded into <var>Imagine</var> without actually doing so.</li>
	<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>		<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>

Alex: /* Syntax for IMAGINE */

2025-05-02T10:47:01Z

Syntax for IMAGINE

← Older revision		Revision as of 10:47, 2 May 2025
Line 19:		Line 19:
	<ul>		<ul>
	<li><var class="term">SYNC</var> indicates that data is to be extracted and the <var>Model 204</var> file and <var>Imagine</var> are to be kept in sync after the command.</li>		<li><var class="term">SYNC</var> indicates that data is to be extracted and the <var>Model 204</var> file and <var>Imagine</var> are to be kept in sync after the command.</li>
	<li><var class="term">~~SYNC<~~/var> indicates that data is to be extracted but the <var>Model 204</var> file and <var>Imagine</var> are not to be kept in sync after the command.</li>		<li><var class="term">EXTRACT/var> indicates that data is to be extracted but the <var>Model 204</var> file and <var>Imagine</var> are not to be kept in sync after the command.</li>
	<li><var class="term">NOCOMMIT</var> indicates that the data is to be sent to Imagine and processed, but not committed. This provides a way of validating that a file can be loaded into <var>Imagine</var> without actually doing so.</li>		<li><var class="term">NOCOMMIT</var> indicates that the data is to be sent to Imagine and processed, but not committed. This provides a way of validating that a file can be loaded into <var>Imagine</var> without actually doing so.</li>
	<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>		<li><var class="term">TICK</var> indicates the number of records between progress messages (M204.3073) to the journal. This parameter also sets the frequency of progress messages on <var>Imagine</var>. <var>TICK</var> defaults to 100000.</li>
Line 32:		Line 32:

	===Syntax notes===		===Syntax notes===

	==Example==		==Example==
	==Usage notes==		==Usage notes==