| Name | Description |
|---|---|
| id | a unique identifier for this page. This id can be used to reference this page when linking to it from another part of the script, or when indicating what page to start at when re-entering a script. |
| entity | the name of an entity from the associated Datastore schema. If used directly within a section, the entity referenced on a page must be a child of the root element within the schema. Any attribute within a cluster on this page which does not have its own entity specified is assumed to be an attribute of this entity. When a page is used within a loop, there is no need to set the entity on the page if it is the same as the entity used for the loop itself |
| criteria | used in combination with the entity attribute to identify the exact record(s) to display/modify on this page. The criteria attribute can be thought of in the same way as the 'where' clause in an SQL statement. If the question-page is not contained within a loop, the IEG Engine will assume that there is only one record which matches the criteria and therefore only select the first record returned, so to ensure that everything works as intended, the criteria should only match a single record in this situation. If no record matches the specified criteria, then no values are displayed in the input fields on this page, and when the data entered by the user is saved, a new record will be created. If no criteria is specified, then there it is assumed that only one instance of the entity exists per root element in the Datastore. If the page is contained within a loop, no criteria should be specified as the criteria for the loop is what will be used. |
| progress | the percentage to use for the progress bar when the user gets to this page. |
| show-person-tabs | when set to true, this attribute will indicate to the IEG Engine and Player that person tabs should be displayed at the top of the page, more information on which can be found in the Flow Control chapter. This should only be used on pages within a loop. |
| read-only | when set to true, this attribute will indicate to the IEG Player that no input controls should be available to the user on this page and instead the values presented should be read-only, as on summary pages. |
| show-back-button | when set to true, this attribute will indicate to the IEG Player that the Back button should be displayed. If not specified, this attribute will be set to true by default. |
| show-exit-button | when set to true, this attribute will indicate to the IEG Player that the Exit button should be displayed. If not specified, this attribute will be set to false by default. |
| show-next-button | when set to true, this attribute will indicate to the IEG Player that the Next button should be displayed. If not specified, this attribute will be set to true by default. |
| show-save-exit-button | when set to true, this attribute will indicate to the IEG Player that the 'Save & Exit' button should be displayed. If not specified, this attribute will be set to true by default. |
| read-only-expression | a boolean expression which, if evaluated to true at runtime, causes the question page to become read-only. |
| set-focus | when set to false, this attribute will indicate to the IEG Player that no initial focus should be set on the form. If not specified, this attribute will be set to true by default. |