Syntax diagrams

Example: APPLICATION Element Syntax Usage.

This syntax diagram describes the APPLICATION configuration element, its attributes, and its child elements:

<APPLICATION [Id=app-name]  
     Parent=parent-app-name 
     [SinglePageApplications={TRUE|FALSE}] 
     xmlns:xsi=uri 
     xsi:noNamespaceSchemaLocation=schema
    [Abstract={TRUE|FALSE}] 
    [mode=mode-name]>
   [<DESCRIPTION>...</DESCRIPTION>]
   [<RESOURCE>...</RESOURCE>] [...]
   [<EXECUTION>...</EXECUTION>]
   [<AUTO_LOGOUT>...</AUTO_LOGOUT>] 
   [<UA_OUTPUT>...</UA_OUTPUT>]
   [<END_URL>...</END_URL>]
   [<HTTP>...</HTTP>]
</APPLICATION>

• Configuration elements are written in uppercase within an opening tag ( <ELEMENT_NAME>) and a closing tag ( </ELEMENT_NAME>)
• If an element has attributes, they appear separated by spaces within the opening tag of the configuration element. Here’s what you need to know:
  1. Attribute structure: An attribute consists of an attribute name, followed by an equals sign (=), followed by the attribute value.
  2. Attribute names: An attribute name is a string with no spaces. Attribute names are presented in code format.
  3. Boolean attributes: For attributes with boolean values, the value must be uppercase: TRUE or FALSE and enclosed in double quotes. Other values such as yes, no, 1, or 0 are not valid. For example, <APPLICATION Abstract="TRUE" />.
  4. Variable attribute values: When an attribute value is shown as a variable, replace it with a valid string. Variables are enclosed in double quotes. For example, <APPLICATION mode="mode_name" />.

• If an XML element takes a boolean value:

  • The boolean value appears as the element’s text content, without quotes. The value must be uppercase TRUE or FALSE. Values such as yes, no, 1, or 0 are not valid. For example: <SEND_VERSION>TRUE</SEND_VERSION>
• Wildcard characters in syntax definitions are usually marked with an underscore. They are used to indicate elements that can either repeat, be mandatory, or be optional.

  Table 1. Wildcard characters

  Wildcards	Description
  [ e ]	Square braces indicate an optional element in the syntax.
  ...	A sign with three dots (ellipsis) indicates that a number of items may appear in a list. If used between an element's opening and closing tags, it indicates one or more child elements may appear.
  [ e1 | e2 ... ]	Square braces containing elements separated by a pipe indicate an optional element to be selected from the list.
  { e1 | e2 ... }	Curly braces containing elements separated by a pipe indicate a mandatory element to be selected from the list.
  [...]	A sign made of square braces with three dots indicate that the previous element can appear more than once.
  [,...]	A sign made of square braces with a comma followed by three dots indicate that the previous element can appear more than once, and must be separated by a comma.