Request composition rules - Revision history

Dme at 14:42, 13 January 2019

2019-01-13T14:42:40Z

← Older revision		Revision as of 14:42, 13 January 2019
Line 1:		Line 1:
			__TOC__

			<p> </p>

			This page summarizes the rules for composing compilable User Language requests.

	==Statement labels==		==Statement labels==
	<p>		<p>
	~~This page summarizes the rules for composing compilable User Language requests.~~ The rules for specifying statement labels in User Language statements are summarized below. </p>		The rules for specifying statement labels in User Language statements are summarized below. </p>
	<ul>		<ul>
	<li>A statement label must begin with a letter (A-Z, a-z) which can be followed by one or more occurrences of a letter (A-Z, a-z), digit (0-9), period (.), or underscore (_). The label can be a maximum of 254 characters in length.</li>		<li>A statement label must begin with a letter (A-Z, a-z) which can be followed by one or more occurrences of a letter (A-Z, a-z), digit (0-9), period (.), or underscore (_). The label can be a maximum of 254 characters in length.</li>
Line 59:		Line 64:
	The rules for constructing User Language statements are summarized below: </p>		The rules for constructing User Language statements are summarized below: </p>

	===~~Begin statements~~ on a new line===		===Start each statement on a new logical line===
	<p>		<p>
	Each statement must begin on a new line unless it follows a ~~THEN~~, ~~ELSE~~, or ~~ELSEIF~~ clause.</p>		Each statement must begin on a new logical line unless it follows a <var>Then</var>, <var>Else</var>, or <var>ElseIf</var> clause.</p>

			<p>Note that, starting with version 7.5 (or earlier versions, using the Sirius Mods), a semicolon can be used to start a new logical line. The following physical line has three logical lines:
			</p>

			<p class="code">if %flag then loop end; end if ;* You might like this style for very short If blocks
			</p>

	===Statement continuation===		===Statement continuation===

JAL at 20:28, 5 August 2014

2014-08-05T20:28:53Z

← Older revision		Revision as of 20:28, 5 August 2014
Line 221:		Line 221:
	<li>When more than one consecutive space appears in a field name, the extra spaces are ignored.</li>		<li>When more than one consecutive space appears in a field name, the extra spaces are ignored.</li>

	<li>A field name can be subscripted by including a parenthesized expression after the name. This facilitates references to multiply occurring fields (see [[~~Operations on~~ multiply occurring fields]]).</li>		<li>A field name can be subscripted by including a parenthesized expression after the name. This facilitates references to multiply occurring fields (see [[Processing multiply occurring fields and field groups]]).</li>

	<li>To refer to a fieldname indirectly, specify it with the format %%name (see the discussion in [[Using variables and values in computation#Field name variables\|Field name variables]]). Field name variables also can be subscripted. </li>		<li>To refer to a fieldname indirectly, specify it with the format %%name (see the discussion in [[Using variables and values in computation#Field name variables\|Field name variables]]). Field name variables also can be subscripted. </li>

JAL at 21:02, 30 April 2014

2014-04-30T21:02:18Z

← Older revision		Revision as of 21:02, 30 April 2014
Line 22:		Line 22:
	<ul>		<ul>
	<li>It immediately follows a STORE RECORD or a FIND statement and an END STORE or END FIND statement is not being used to end the statement. In this case, the statement label indicates the end of the preceding statement. </li>		<li>It immediately follows a STORE RECORD or a FIND statement and an END STORE or END FIND statement is not being used to end the statement. In this case, the statement label indicates the end of the preceding statement. </li>
	~~</li>~~
	<li>It is referred to by later statements. In most requests, COUNT, FIND, FOR EACH OCCURRENCE, FOR EACH VALUE, NOTE, and SUBROUTINE, are referred to later and should therefore be labeled. </li>		<li>It is referred to by later statements. In most requests, COUNT, FIND, FOR EACH OCCURRENCE, FOR EACH VALUE, NOTE, and SUBROUTINE, are referred to later and should therefore be labeled. </li>
	~~</li>~~
	</ul>		</ul>

Line 35:		Line 34:
	===Label references===		===Label references===
	<p>		<p>
	Labels allow statements to refer to other User Language statements. The label reference must be coded exactly as the label, including upper- and lowercase lettering. However, the label reference must omit the colon. </p>		Labels allow statements to refer to other User Language statements. The label reference must be coded exactly as the label, including upper- and lowercase lettering. However, the label reference must omit the colon. </p>

	==Statement block ends==		==Statement block ends==
Line 48:		Line 47:
	<ul>		<ul>
	<li>The appropriate block end statement (END {statement type} [label]) can be used to end any block. </li>		<li>The appropriate block end statement (END {statement type} [label]) can be used to end any block. </li>
	~~</li>~~
	<li>A label can be used to end blocks of multiline conditions (blocks begun by the FIND and STORE statements). A label cannot be used to end blocks of nested statements (blocks begun by the FOR, IF, ON, REPEAT, or SUBROUTINE statements).</li>		<li>A label can be used to end blocks of multiline conditions (blocks begun by the FIND and STORE statements). A label cannot be used to end blocks of nested statements (blocks begun by the FOR, IF, ON, REPEAT, or SUBROUTINE statements).</li>
	~~</li>~~
	<li>The END BLOCK statement can be used to end any block except for blocks of multiline conditions (blocks begun by the FIND and STORE statements). </li>		<li>The END BLOCK statement can be used to end any block except for blocks of multiline conditions (blocks begun by the FIND and STORE statements). </li>
	~~</li>~~
	<li>END, END MORE, END NORUN, and END USE can be used to end any block, because these forms the END statement terminate the request, thereby ending all statements within the request. </li>		<li>END, END MORE, END NORUN, and END USE can be used to end any block, because these forms the END statement terminate the request, thereby ending all statements within the request. </li>
	~~</li>~~
	</ul>		</ul>

Line 77:		Line 75:
	<ul>		<ul>
	<li>[[Record retrievals#Interpretation of Boolean operators in retrievals\|Interpretation of Boolean operators in retrievals]] for a discussion of line continuation in FIND statements</li>		<li>[[Record retrievals#Interpretation of Boolean operators in retrievals\|Interpretation of Boolean operators in retrievals]] for a discussion of line continuation in FIND statements</li>
	~~</li>~~
	<li>[[Record loops#Specify retrieval criteria on one logical line\|Specify retrieval criteria on one logical line]] in FR WHERE statements.</li>		<li>[[Record loops#Specify retrieval criteria on one logical line\|Specify retrieval criteria on one logical line]] in FR WHERE statements.</li>
	~~</li>~~
	</ul>		</ul>

Line 159:		Line 156:
	The following statements might require the use of multiple logical lines:</p>		The following statements might require the use of multiple logical lines:</p>
	<ul>		<ul>
	<li>FIND~~</li>~~		<li>FIND
	<p>		<p>
	The first retrieval condition for a FIND statement can appear on the same line as the FIND clause. Other retrieval conditions which start a new line are preceded implicitly by a logical AND.</p>		The first retrieval condition for a FIND statement can appear on the same line as the FIND clause. Other retrieval conditions which start a new line are preceded implicitly by a logical AND.</p>
	</li>		</li>
	<li>IF and ELSEIF~~</li>~~
			<li>IF and ELSEIF
	<p>		<p>
	The conditional expression in an IF statement or ELSEIF clause can begin on the same line as IF or ELSEIF on the next line. Each new line in the expression is preceded implicitly by a logical AND. THEN can appear on the same line as the expression or on the next line. </p>		The conditional expression in an IF statement or ELSEIF clause can begin on the same line as IF or ELSEIF on the next line. Each new line in the expression is preceded implicitly by a logical AND. THEN can appear on the same line as the expression or on the next line. </p>
	</li>		</li>
	<li>STORE RECORD~~</li>~~
			<li>STORE RECORD
	<p>		<p>
	Each fieldname = value pair of a record to be stored must be entered on a new line.</p>		Each fieldname = value pair of a record to be stored must be entered on a new line.</p></li>
	</li>
	</ul>		</ul>
	<p>		<p>
Line 216:		Line 214:
	<li>Any word or character, including space, can be used as part of a field name except the correction characters @ and #. The choice of symbols to signify correction characters is parameter controlled and can be changed. If you chooses different symbols, the restriction regarding the use of @ and # in field names then applies to the new symbols instead.		<li>Any word or character, including space, can be used as part of a field name except the correction characters @ and #. The choice of symbols to signify correction characters is parameter controlled and can be changed. If you chooses different symbols, the restriction regarding the use of @ and # in field names then applies to the new symbols instead.
	(See the [[List of Model 204 parameters]].) </li>		(See the [[List of Model 204 parameters]].) </li>

	<li>If any reserved word or character is embedded in a field name, the word or character must be part of a quoted string (see the discussion on field attributes in [[Field attributes]]).</li>		<li>If any reserved word or character is embedded in a field name, the word or character must be part of a quoted string (see the discussion on field attributes in [[Field attributes]]).</li>

Line 286:		Line 285:
	<ul>		<ul>
	<li>Following a PRINT statement, any characters enclosed in single quotes are printed literally when the statement is executed. </li>		<li>Following a PRINT statement, any characters enclosed in single quotes are printed literally when the statement is executed. </li>

			<li>Within a request, quotation marks can be used to provide titles for output or display messages to the end user.
	</li>		</li>
	~~<li>Within a request, quotation marks can be used to provide titles for output or display messages to the end user. </li>~~
	~~</li>~~
	<li>Quoted material can be included in a list with other things to be printed (see PRINT statement).</li>		<li>Quoted material can be included in a list with other things to be printed (see PRINT statement).</li>
	~~</li>~~
	<li>Quoted material can be used in expressions.</li>		<li>Quoted material can be used in expressions.</li>
	~~</li>~~
	<li>Quoted material can be saved by the NOTE statement for later use in a request. </li>		<li>Quoted material can be saved by the NOTE statement for later use in a request. </li>
	~~</li>~~
	<li>Single quotes also are used when a reserved word or symbol is to be interpreted in other than its standard system sense. Thus when reserved words or symbols are used in the formation of field names or values, the entire string must be enclosed in quotation marks.</li>		<li>Single quotes also are used when a reserved word or symbol is to be interpreted in other than its standard system sense. Thus when reserved words or symbols are used in the formation of field names or values, the entire string must be enclosed in quotation marks.</li>
	~~</li>~~
	</ul>		</ul>

Line 304:		Line 303:
	<ol>		<ol>
	<li>A pair of single quotation marks, for example 'TEXT', delineates a quoted string.</li>		<li>A pair of single quotation marks, for example 'TEXT', delineates a quoted string.</li>

	<li>Quoted strings are stored and utilized with quote marks dropped. Thus <var>PARENTS = 'MARY AND JOHN SMITH'</var> is stored as <var>PARENTS = MARY</var><var> </var><var>AND JOHN SMITH</var>, and the statement <var>PRINT PARENTS</var> results in the output <var>MARY AND JOHN SMITH</var>.</li>		<li>Quoted strings are stored and utilized with quote marks dropped. Thus <var>PARENTS = 'MARY AND JOHN SMITH'</var> is stored as <var>PARENTS = MARY</var><var> </var><var>AND JOHN SMITH</var>, and the statement <var>PRINT PARENTS</var> results in the output <var>MARY AND JOHN SMITH</var>.</li>

	<li>A pair of consecutive quotation marks inside of a quoted string is replaced by a single quotation mark when the string is stored or printed. For example, <var>PRINT </var><var>'FATHER"S NAME'</var> results in the output <var>FATHER'S NAME</var> and <var>PRINT "AND"</var> yields <var>'AND'</var>.</li>		<li>A pair of consecutive quotation marks inside of a quoted string is replaced by a single quotation mark when the string is stored or printed. For example, <var>PRINT </var><var>'FATHER"S NAME'</var> results in the output <var>FATHER'S NAME</var> and <var>PRINT "AND"</var> yields <var>'AND'</var>.</li>

	<li>A pair of consecutive quotation marks that is not included in a quoted string converts to a character string of zero length, called a null string. </li>		<li>A pair of consecutive quotation marks that is not included in a quoted string converts to a character string of zero length, called a null string. </li>

	<li>Only pairs of quotation marks are used. </li>		<li>Only pairs of quotation marks are used. </li>
	</ol>		</ol>

JAL at 18:30, 8 January 2014

2014-01-08T18:30:19Z

Show changes

JAL at 21:00, 2 January 2014

2014-01-02T21:00:08Z

← Older revision		Revision as of 21:00, 2 January 2014
Line 149:		Line 149:
	<ol>		<ol>
	<li>Any word or character, including space, can be used as part of a field name except the correction characters @ and #. The choice of symbols to signify correction characters is parameter controlled and can be changed. If you chooses different symbols, the restriction regarding the use of @ and # in field names then applies to the new symbols instead. (See the Rocket <var class="product">Model 204</var> Parameter and Command Reference Manual.) </li>		<li>Any word or character, including space, can be used as part of a field name except the correction characters @ and #. The choice of symbols to signify correction characters is parameter controlled and can be changed. If you chooses different symbols, the restriction regarding the use of @ and # in field names then applies to the new symbols instead. (See the Rocket <var class="product">Model 204</var> Parameter and Command Reference Manual.) </li>
	<li>If any reserved word or character is embedded in a field name, the word or character must be part of a quoted string (see the discussion on field attributes in [[Field ~~Attributes#Field Attributes\|Field Attributes~~]]).</li>		<li>If any reserved word or character is embedded in a field name, the word or character must be part of a quoted string (see the discussion on field attributes in [[Field attributes]]).</li>

	<li>Field names that contain a colon followed by a space (for example, COLOR: CAR) cannot be distinguished from labels when used as the first word on a line. Any field name containing this combination either should be renamed or must be enclosed in single quotes at the beginning of a line.</li>		<li>Field names that contain a colon followed by a space (for example, COLOR: CAR) cannot be distinguished from labels when used as the first word on a line. Any field name containing this combination either should be renamed or must be enclosed in single quotes at the beginning of a line.</li>

	<li>When more than one consecutive space appears in a field name, the extra spaces are ignored.</li>		<li>When more than one consecutive space appears in a field name, the extra spaces are ignored.</li>

JAL at 17:46, 2 January 2014

2014-01-02T17:46:13Z

← Older revision		Revision as of 17:46, 2 January 2014
Line 150:		Line 150:
	<li>Any word or character, including space, can be used as part of a field name except the correction characters @ and #. The choice of symbols to signify correction characters is parameter controlled and can be changed. If you chooses different symbols, the restriction regarding the use of @ and # in field names then applies to the new symbols instead. (See the Rocket <var class="product">Model 204</var> Parameter and Command Reference Manual.) </li>		<li>Any word or character, including space, can be used as part of a field name except the correction characters @ and #. The choice of symbols to signify correction characters is parameter controlled and can be changed. If you chooses different symbols, the restriction regarding the use of @ and # in field names then applies to the new symbols instead. (See the Rocket <var class="product">Model 204</var> Parameter and Command Reference Manual.) </li>
	<li>If any reserved word or character is embedded in a field name, the word or character must be part of a quoted string (see the discussion on field attributes in [[Field Attributes#Field Attributes\|Field Attributes]]).</li>		<li>If any reserved word or character is embedded in a field name, the word or character must be part of a quoted string (see the discussion on field attributes in [[Field Attributes#Field Attributes\|Field Attributes]]).</li>

	<li>Field names that contain a colon followed by a space (for example, COLOR: CAR) cannot be distinguished from labels when used as the first word on a line. Any field name containing this combination either should be renamed or must be enclosed in single quotes at the beginning of a line.</li>		<li>Field names that contain a colon followed by a space (for example, COLOR: CAR) cannot be distinguished from labels when used as the first word on a line. Any field name containing this combination either should be renamed or must be enclosed in single quotes at the beginning of a line.</li>
	<li>When more than one consecutive space appears in a field name, the extra spaces are ignored.</li>		<li>When more than one consecutive space appears in a field name, the extra spaces are ignored.</li>
	<li>A field name can be subscripted by including a parenthesized expression after the name. This facilitates references to multiply occurring fields (see [[Operations on ~~Multiply Occurring Fields#Operations on Multiply Occurring Fields\|Operations on Multiply Occurring Fields~~]]).</li>
			<li>A field name can be subscripted by including a parenthesized expression after the name. This facilitates references to multiply occurring fields (see [[Operations on multiply occurring fields]]).</li>

	<li>To refer to a fieldname indirectly, specify it with the format %%name (see the discussion in [[Using variables and values in computation#Field name variables\|Field name variables]]). Field name variables also can be subscripted. </li>		<li>To refer to a fieldname indirectly, specify it with the format %%name (see the discussion in [[Using variables and values in computation#Field name variables\|Field name variables]]). Field name variables also can be subscripted. </li>
	</ol>		</ol>

JAL at 16:55, 2 January 2014

2014-01-02T16:55:06Z

← Older revision		Revision as of 16:55, 2 January 2014
Line 52:		Line 52:
	<li>[[Record retrievals#Interpretation of Boolean operators in retrievals\|Interpretation of Boolean operators in retrievals]] for a discussion of line continuation in FIND statements</li>		<li>[[Record retrievals#Interpretation of Boolean operators in retrievals\|Interpretation of Boolean operators in retrievals]] for a discussion of line continuation in FIND statements</li>
	</li>		</li>
	<li>[[Record ~~Loops~~#Specify retrieval criteria on one logical line\|Specify retrieval criteria on one logical line]] in FR WHERE statements.</li>		<li>[[Record loops#Specify retrieval criteria on one logical line\|Specify retrieval criteria on one logical line]] in FR WHERE statements.</li>
	</li>		</li>
	</ul>		</ul>

Admin: Admin moved page Request Composition Rules to Request composition rules without leaving a redirect

2014-01-02T16:46:27Z

Admin moved page Request Composition Rules to Request composition rules without leaving a redirect

← Older revision	Revision as of 16:46, 2 January 2014
(No difference)

JAL at 00:00, 2 January 2014

2014-01-02T00:00:50Z

← Older revision		Revision as of 00:00, 2 January 2014
Line 153:		Line 153:
	<li>When more than one consecutive space appears in a field name, the extra spaces are ignored.</li>		<li>When more than one consecutive space appears in a field name, the extra spaces are ignored.</li>
	<li>A field name can be subscripted by including a parenthesized expression after the name. This facilitates references to multiply occurring fields (see [[Operations on Multiply Occurring Fields#Operations on Multiply Occurring Fields\|Operations on Multiply Occurring Fields]]).</li>		<li>A field name can be subscripted by including a parenthesized expression after the name. This facilitates references to multiply occurring fields (see [[Operations on Multiply Occurring Fields#Operations on Multiply Occurring Fields\|Operations on Multiply Occurring Fields]]).</li>
	<li>To refer to a fieldname indirectly, specify it with the format %%name (see the discussion in [[Using ~~Variables~~ and ~~Values~~ in ~~Computation~~#Field name variables\|Field name variables]]). Field name variables also can be subscripted. </li>		<li>To refer to a fieldname indirectly, specify it with the format %%name (see the discussion in [[Using variables and values in computation#Field name variables\|Field name variables]]). Field name variables also can be subscripted. </li>
	</ol>		</ol>
	<b>Examples</b>		<b>Examples</b>

Dme at 13:35, 17 August 2013

2013-08-17T13:35:12Z

← Older revision		Revision as of 13:35, 17 August 2013
Line 50:		Line 50:
	<p>You can continue statements using parentheses, although Rocket Software recommends that you use parentheses only to change the order of precedence in retrieval statements or with FR WHERE statements. See:</p>		<p>You can continue statements using parentheses, although Rocket Software recommends that you use parentheses only to change the order of precedence in retrieval statements or with FR WHERE statements. See:</p>
	<ul>		<ul>
	<li>[[Record ~~Retrievals~~#Interpretation of Boolean operators in retrievals\|Interpretation of Boolean operators in retrievals]] for a discussion of line continuation in FIND statements</li>		<li>[[Record retrievals#Interpretation of Boolean operators in retrievals\|Interpretation of Boolean operators in retrievals]] for a discussion of line continuation in FIND statements</li>
	</li>		</li>
	<li>[[Record Loops#Specify retrieval criteria on one logical line\|Specify retrieval criteria on one logical line]] in FR WHERE statements.</li>		<li>[[Record Loops#Specify retrieval criteria on one logical line\|Specify retrieval criteria on one logical line]] in FR WHERE statements.</li>