Global features - Revision history

JDamon: /* Syntax */

2026-04-23T17:47:34Z

Syntax

← Older revision		Revision as of 17:47, 23 April 2026
Line 599:		Line 599:

	<li><var class="term">position_name</var> is a name that you assigned to the remembered position when you stored it on a previous <var>Remember</var> statement. </li>		<li><var class="term">position_name</var> is a name that you assigned to the remembered position when you stored it on a previous <var>Remember</var> statement. </li>
	<p><b>NOTE:</b>If the 'position_name' is mixed or lower case, be sure to enclose it here in single ~~quotes~~. Do the same when referring to that name in other statements; e.g. CLEAR or REMEMBER.</p>		<p><b>NOTE:</b>If the 'position_name' is mixed or lower case, be sure to enclose it here in single quotation marks. Do the same when referring to that name in other statements; e.g. CLEAR or REMEMBER.</p>
	</ul>		</ul>

JDamon: /* Syntax */

2026-04-23T17:44:11Z

Syntax

← Older revision		Revision as of 17:44, 23 April 2026
Line 873:		Line 873:

	<li><var class="term">objectname</var> is the literal name of the specific global object to be cleared from GTBL. Enclose <var class="term">objectname</var> in single quotation marks.</li>		<li><var class="term">objectname</var> is the literal name of the specific global object to be cleared from GTBL. Enclose <var class="term">objectname</var> in single quotation marks.</li>
	<p><b>NOTE:</b> If the <i>objectname</i> is mixed case, be sure to ~~use the same name,~~ in single quotation marks, when referring to that name in other statements; e.g. REMEMBER or POSITION.</p>		<p><b>NOTE:</b> If the <i>'objectname'</i> is mixed or lower case, be sure to enclose it here in single quotation marks. Do the same when referring to that name in other statements; e.g. REMEMBER or POSITION.</p>

	<li><var class="term">%variable</var> contains a value that specifies the global object to be cleared from GTBL. </li>		<li><var class="term">%variable</var> contains a value that specifies the global object to be cleared from GTBL. </li>

JDamon: /* Remember statement */

2026-04-23T17:41:12Z

Remember statement

← Older revision		Revision as of 17:41, 23 April 2026
Line 560:		Line 560:

	<li><var class="term">position_name</var> is a unique object name you assign to the <var>Remember</var> position. </li>		<li><var class="term">position_name</var> is a unique object name you assign to the <var>Remember</var> position. </li>
	<p><b>NOTE:</b>If the 'position_name' is mixed or lower case, be sure to ~~use the same name,~~ in single quotation marks, when referring to that name in other statements; e.g. CLEAR or POSITION.</p>		<p><b>NOTE:</b>If the 'position_name' is mixed or lower case, be sure to enclose it here in single quotation marks. Do the same when referring to that name in other statements; e.g. CLEAR or POSITION.</p>

	<li><var class="term">foundsortset_name</var> or <var class="term">list_name</var> must be identical to the listname or label specified on the <var>For</var> loop:		<li><var class="term">foundsortset_name</var> or <var class="term">list_name</var> must be identical to the listname or label specified on the <var>For</var> loop:

JDamon: /* Syntax */

2026-04-23T17:38:03Z

Syntax

← Older revision		Revision as of 17:38, 23 April 2026
Line 599:		Line 599:

	<li><var class="term">position_name</var> is a name that you assigned to the remembered position when you stored it on a previous <var>Remember</var> statement. </li>		<li><var class="term">position_name</var> is a name that you assigned to the remembered position when you stored it on a previous <var>Remember</var> statement. </li>
			<p><b>NOTE:</b>If the 'position_name' is mixed or lower case, be sure to enclose it here in single quotes. Do the same when referring to that name in other statements; e.g. CLEAR or REMEMBER.</p>
	</ul>		</ul>

	====Usage notes====		====Usage notes====
	<p>		<p>

JDamon: /* Syntax */

2026-04-23T17:31:03Z

Syntax

← Older revision		Revision as of 17:31, 23 April 2026
Line 554:		Line 554:
	Where:		Where:
	<ul>		<ul>
	<li>The <var>Global</var> option implies ~~Perm~~ and the position is retained in GTBL after the current request terminates. If <var>Global</var> is not specified, TEMP is implied and the position is cleared from GTBL after the current request terminates.</li>		<li>The <var>Global</var> option implies '''PERM''' and the position is retained in GTBL after the current request terminates. If <var>Global</var> is not specified, '''TEMP''' is implied and the position is cleared from GTBL after the current request terminates.</li>
	<p><b>NOTE:</B> The use of GLOBAL here must be consistent with the CLEAR GLOBAL POSITION statement. If the latter is specified with PERM:</p>		<p><b>NOTE:</B> The use of GLOBAL here must be consistent with the CLEAR GLOBAL POSITION statement. If the latter is specified with PERM:</p>
	<p>CLEAR GLOBAL POSITION <b>PERM</b> 'position_name',</p>		<p>CLEAR GLOBAL POSITION <b>PERM</b> 'position_name',</p>
Line 560:		Line 560:

	<li><var class="term">position_name</var> is a unique object name you assign to the <var>Remember</var> position. </li>		<li><var class="term">position_name</var> is a unique object name you assign to the <var>Remember</var> position. </li>
			<p><b>NOTE:</b>If the 'position_name' is mixed or lower case, be sure to use the same name, in single quotation marks, when referring to that name in other statements; e.g. CLEAR or POSITION.</p>

	<li><var class="term">foundsortset_name</var> or <var class="term">list_name</var> must be identical to the listname or label specified on the <var>For</var> loop:		<li><var class="term">foundsortset_name</var> or <var class="term">list_name</var> must be identical to the listname or label specified on the <var>For</var> loop:

JDamon: /* Remember statement */

2026-04-23T17:07:37Z

Remember statement

← Older revision		Revision as of 17:07, 23 April 2026
Line 556:		Line 556:
	<li>The <var>Global</var> option implies Perm and the position is retained in GTBL after the current request terminates. If <var>Global</var> is not specified, TEMP is implied and the position is cleared from GTBL after the current request terminates.</li>		<li>The <var>Global</var> option implies Perm and the position is retained in GTBL after the current request terminates. If <var>Global</var> is not specified, TEMP is implied and the position is cleared from GTBL after the current request terminates.</li>
	<p><b>NOTE:</B> The use of GLOBAL here must be consistent with the CLEAR GLOBAL POSITION statement. If the latter is specified with PERM:</p>		<p><b>NOTE:</B> The use of GLOBAL here must be consistent with the CLEAR GLOBAL POSITION statement. If the latter is specified with PERM:</p>
	<p>CLEAR GLOBAL POSITION <b>PERM</b> '~~objectname~~',</p>		<p>CLEAR GLOBAL POSITION <b>PERM</b> 'position_name',</p>
	<p>then the REMEMBER statement must specify GLOBAL because it implies PERM.</p>		<p>then the REMEMBER statement must specify GLOBAL because it implies PERM.</p>

JDamon: /* Syntax */

2026-04-13T20:08:20Z

Syntax

← Older revision		Revision as of 20:08, 13 April 2026
Line 554:		Line 554:
	Where:		Where:
	<ul>		<ul>
	<li>The <var>Global</var> option ~~retains~~ the ~~<var>Remember</var>~~ position after the current request terminates. If <var>Global</var> is not specified, the position ~~is temporary, and it~~ is cleared from GTBL after the current request terminates. </li>		<li>The <var>Global</var> option implies Perm and the position is retained in GTBL after the current request terminates. If <var>Global</var> is not specified, TEMP is implied and the position is cleared from GTBL after the current request terminates.</li>
			<p><b>NOTE:</B> The use of GLOBAL here must be consistent with the CLEAR GLOBAL POSITION statement. If the latter is specified with PERM:</p>
			<p>CLEAR GLOBAL POSITION <b>PERM</b> 'objectname',</p>
			<p>then the REMEMBER statement must specify GLOBAL because it implies PERM.</p>

	<li><var class="term">position_name</var> is a unique object name you assign to the <var>Remember</var> position. </li>		<li><var class="term">position_name</var> is a unique object name you assign to the <var>Remember</var> position. </li>
Line 565:		Line 568:
	</ul></li>		</ul></li>
	</ul>		</ul>

	====Usage notes====		====Usage notes====
	<p>		<p>

JDamon: /* Syntax */

2026-04-13T19:29:24Z

Syntax

← Older revision		Revision as of 19:29, 13 April 2026
Line 864:		Line 864:
	<li><var>Global</var> clears a specific global object from GTBL. You cannot clear a global string variable created with the <var>$Setg</var> function using this form. </li>		<li><var>Global</var> clears a specific global object from GTBL. You cannot clear a global string variable created with the <var>$Setg</var> function using this form. </li>

			<li><var>Position [Perm \| Temp]</var> The use of PERM or TEMP must be consistent with GLOBAL in the REMEMBER statement. If GLOBAL is specified in the REMEMBER statement, then PERM is implied. If GLOBAL is omitted from the REMEMBER statement, TEMP is implied.
			</li>

	<li><var class="term">objectname</var> is the literal name of the specific global object to be cleared from GTBL. Enclose <var class="term">objectname</var> in single quotation marks.</li>		<li><var class="term">objectname</var> is the literal name of the specific global object to be cleared from GTBL. Enclose <var class="term">objectname</var> in single quotation marks.</li>
			<p><b>NOTE:</b> If the <i>objectname</i> is mixed case, be sure to use the same name, in single quotation marks, when referring to that name in other statements; e.g. REMEMBER or POSITION.</p>

	<li><var class="term">%variable</var> contains a value that specifies the global object to be cleared from GTBL. </li>		<li><var class="term">%variable</var> contains a value that specifies the global object to be cleared from GTBL. </li>

JAL: mixed case for statements

2018-05-29T23:46:42Z

mixed case for statements

Show changes

JAL: misc formatting

2018-05-29T21:42:46Z

misc formatting

← Older revision		Revision as of 21:42, 29 May 2018
Line 40:		Line 40:
	</ul>		</ul>
	<p>		<p>
	As of Version 5.1, you can increase the speed and reduce the CPU time to find and update a global string variable by setting the <var>[[GTBLHASH parameter\|GTBLHASH]]</var> parameter to a nonzero value. The GTBLHASH parameter specifies the number of buckets allocated in the global string variable section of GTBL.		As of Version 5.1, you can increase the speed and reduce the CPU time to find and update a global string variable by setting the <var>[[GTBLHASH parameter\|GTBLHASH]]</var> parameter to a nonzero value. The <var>GTBLHASH</var> parameter specifies the number of buckets allocated in the global string variable section of GTBL.
	When GTBLHASH is a nonzero value, and you set or get a global string variable, the global string variable name is hashed to determine the bucket in which the name is located. </p>		When <var>GTBLHASH</var> is a nonzero value, and you set or get a global string variable, the global string variable name is hashed to determine the bucket in which the name is located. </p>
	<p>		<p>
	This reduces the overall amount of data that must be scanned to find a global string variable or must be moved when a value is deleted or changes in size. If GTBLHASH=0, global string variables are processed as in pre-5.1 versions of <var class="product">Model 204</var>.		This reduces the overall amount of data that must be scanned to find a global string variable or must be moved when a value is deleted or changes in size. If <var>GTBLHASH</var> is 0, global string variables are processed as in pre-5.1 versions of <var class="product">Model 204</var>. </p>
	</p>
	<p>		<p>
	The <var>[[GTBLPCT parameter\|GTBLPCT]]</var> parameter determines the initial percentage of GTBL to allocate for global string variables. The default value of GTBLPCT is 50, meaning 50 percent of GTBL is initially allocated for global variable strings. The remainder, in this case 50 percent, is the initial allocation for global objects. However, if GTBLHASH=0, a nonzero setting for GTBLPCT has no effect. </p>		The <var>[[GTBLPCT parameter\|GTBLPCT]]</var> parameter determines the initial percentage of GTBL to allocate for global string variables. The default value of <var>GTBLPCT</var> is 50, meaning 50 percent of GTBL is initially allocated for global variable strings. The remainder, in this case 50 percent, is the initial allocation for global objects. However, if <var>GTBLHASH</var> is 0, a nonzero setting for <var>GTBLPCT</var> has no effect. </p>
	<p>		<p>
	When in effect, if either area of GTBL fills and there are still free pages in GTBL, then GTBL can be rearranged if more space is required in the full area of GTBL. Because these rearrangements can be CPU intensive, Rocket Software recommends that you determine an accurate setting for GTBLPCT to avoid frequent rearrangements. You can monitor the performance of the hash GTBL feature using the GTBLRU user statistic and the GTBLRS since-last statistic.		When in effect, if either area of GTBL fills and there are still free pages in GTBL, then GTBL can be rearranged if more space is required in the full area of GTBL. Because these rearrangements can be CPU intensive, Rocket Software recommends that you determine an accurate setting for <var>GTBLPCT</var> to avoid frequent rearrangements. You can monitor the performance of the hash GTBL feature using the <code>GTBLRU</code> user statistic and the <code>GTBLRS</code> since-last statistic.
	</p>		</p>

Line 73:		Line 72:
	After reviewing the GTBLRU and GTBLRS statistics, you can consider taking the following actions: </p>		After reviewing the GTBLRU and GTBLRS statistics, you can consider taking the following actions: </p>
	<ul>		<ul>
	<li>If both of these values are high, increase the size of GTBL by increasing LGTBL. </li>		<li>If both of these values are high, increase the size of GTBL by increasing <var>LGTBL</var>. </li>

	<li>If GTBLRU is high but GTBLRS is not, increase GTBLPCT or decrease GTBLHASH. </li>		<li>If GTBLRU is high but GTBLRS is not, increase <var>GTBLPCT</var> or decrease <var>GTBLHASH</var>. </li>

	<li>If GTBLRS is high but GTBLRU is low, decrease GTBLPCT.		<li>If GTBLRS is high but GTBLRU is low, decrease <var>GTBLPCT</var>. </li>
	</li>
	</ul>		</ul>

	===Global found sets and lists===		===Global found sets and lists===
	<p>		<p>
	You can use global found sets and lists to make found sets and lists available across request boundaries. A global found set or list remains in GTBL until you:</p>		You can use global found sets and lists to make found sets and lists available across request boundaries. A global found set or list remains in GTBL until you: </p>
	<ul>		<ul>
	<li>Explicitly delete it</li>		<li>Explicitly delete it</li>

	<li>Issue a ~~RELEASE~~ or ~~COMMIT RELEASE~~ statement</li>		<li>Issue a <var>Release</var> or <var>Commit Release</var> statement </li>

	<li>The file or group it refers to is closed, including the file close processing done when exiting a subsystem or stopping</li>		<li>The file or group it refers to is closed, including the file close processing done when exiting a subsystem or stopping </li>

	<li>Log out		<li>Log out </li>
	</li>
	</ul>		</ul>
	<p>		<p>
	Sorted sets are a subgroup of found sets; they are treated the same by the ~~CLEAR~~ statement that is used to clear global found sets.</p>		Sorted sets are a subgroup of found sets; they are treated the same by the <var>Clear</var> statement that is used to clear global found sets.</p>

	====Faster global variable processing option====		====Faster global variable processing option====
	<p>		<p>
	When global lists or found sets are processed as part of the ~~FIND~~ or ~~PLACE RECORDS ON~~ statement, it must be verified that a global variable representing the list or found set exists in GTBL. The CLEARG command or ~~CLEAR~~ statement may delete the global variable, so an internal routine is called to verify whether the global variable is in GTBL. The internal routine creates a new copy, if it was deleted. </p>		When global lists or found sets are processed as part of the <var>Find</var> or <var>Place Records On</var> statement, it must be verified that a global variable representing the list or found set exists in GTBL. The <var>CLEARG</var> command or <var>Clear</var> statement may delete the global variable, so an internal routine is called to verify whether the global variable is in GTBL. The internal routine creates a new copy, if it was deleted. </p>
	<p>		<p>
	The internal routine scans NTBL to find an entry that points to the required variable, then it uses its hash value to scan GTBL. Scanning a large NTBL may take considerable time. </p>		The internal routine scans NTBL to find an entry that points to the required variable, then it uses its hash value to scan GTBL. Scanning a large NTBL may take considerable time. </p>
Line 105:		Line 102:
	The NTBL scan can be eliminated, if internal variables representing global lists and found sets contain a global name hash value. Thus, an internal variable with a length of eight bytes that contains an NTBL entry offset points to the internal variable representing a global list or found set. This method avoids an NTBL scan, if a global variable has been deleted from GTBL. </p>		The NTBL scan can be eliminated, if internal variables representing global lists and found sets contain a global name hash value. Thus, an internal variable with a length of eight bytes that contains an NTBL entry offset points to the internal variable representing a global list or found set. This method avoids an NTBL scan, if a global variable has been deleted from GTBL. </p>
	<p>		<p>
	This faster global variable processing requires larger VTBL, because every global list or found set needs eight more bytes. If you want the benefit of this increased processing speed and can accommodate the increased VTBL requirement, set FASTGLOB=1. To maintain existing processing you can let <var>[[FASTGLOB parameter\|FASTGLOB]]</var> default to 0 or explicitly set FASTGLOB=0.		This faster global variable processing requires larger VTBL, because every global list or found set needs eight more bytes. If you want the benefit of this increased processing speed and can accommodate the increased VTBL requirement, set <var>FASTGLOB</var> to 1. To maintain existing processing you can let <var>[[FASTGLOB parameter\|FASTGLOB]]</var> default to 0, or you can explicitly set <var>FASTGLOB</var> to 0.
	</p>		</p>

Line 131:		Line 128:
	Entries in the GTBL consist of global name=value pairs. The names and values of the global string variables are created with the <var>$Setg</var> function from within a request. </p>		Entries in the GTBL consist of global name=value pairs. The names and values of the global string variables are created with the <var>$Setg</var> function from within a request. </p>
	<ul>		<ul>
	<li>A global string variable name can consist of up to 255 characters and follows the naming conventions for variables (see [[Using variables and values in computation#%Variable names\|%Variable names]]). Global string variables that contain special characters, other than a period (<tt>.</tt>) cannot be used as ?& dummy strings. </li>		<li>A global string variable name can consist of up to 255 characters and follows the naming conventions for variables (see [[Using variables and values in computation#%Variable names\|%Variable names]]). Global string variables that contain special characters, other than a period (<tt>.</tt>) cannot be used as <code>?&</code> dummy strings. </li>

	<li>A value can be 0, null string, to 255 characters. </li>		<li>A value can be 0, the null string, or up to 255 characters. </li>
	</ul>		</ul>