Comprehensive Attribute List
The following lists cover most attributes with predefined uses within clevr. These attribute names should be considered reserved and only be used for their described purpose.
Javascript Events
| Attribute |
Description |
| docReady |
Triggers the at form load. |
| after-tab-load |
Triggers after docReady and before the rest of the form. |
| onBlur |
This attribute is not on our recommended events to use in clevr.
Triggers when an element is unfocused / deselected. |
| onChange |
Triggers when the element’s value is changed. The change must be saved to take effect. |
| onClick |
Triggers when an element is clicked on. |
| onFocus |
This attribute is not on our recommended events to use in clevr.
Triggers when an element is becomes the focused element on a page, or becomes selected. |
| onKeyUp |
This attribute is not on our recommended events to use in clevr.
Triggers when an element is focused on and a keyboard key press is released. |
| onLoad |
This attribute is not on our recommended events to use in clevr.
Triggers when the page is completely loaded. Please note that this differs from docReady in that the page may be loaded before the form is properly loaded. |
| onMouseOut |
This attribute is not on our recommended events to use in clevr.
Triggers when the mouse leaves the visible area of an element. |
| onMouseOver |
This attribute is not on our recommended events to use in clevr.
Triggers when the mouse enters the visible area of an element. |
| onRepeaterAdd |
Triggers when a new instance of a repeater is added. |
| onRepeaterDelete |
Triggers when an instance of a repeater is removed. |
| afterInt |
Triggers after a data integration. |
HTML Attributes
| Attribute |
Description |
| class |
A selector. Multiple elements can have the same class so that they will all be selected. |
| disabled |
With a value of true, this will prevent users from interacting with the element. With a value of false, this will allow users to interact with an element. |
| id |
A selector. Every id on a form should be unique. Ids are used to refer to a single element. |
| name |
Groups of radio buttons are connected by having the same name attribute.
Groups of named radio buttons must be on the same tab and in the same container. |
| readonly |
Prevents user’s from entering data into an element while still allowing the user to copy the element’s data. |
| src |
Used for the base type “Image”. The value will be the location/link to the image file. |
| style |
Allows for CSS styling on the element. |
| tabindex |
Sets the tab order based on the element with this attribute in ascending order. The value must be an integer. |
Integration
| Attribute |
Description |
| SISAction |
The SISMethod value from the SIS Field Mapping Chart. Generally unneccessary for SIS Integration. |
| SISField |
The SISField value from the SIS Field Mapping Chart. Generally unneccessary for SIS Integration. |
| SISFieldAlias |
The SISFieldAlias value from the SIS Field Mapping Chart. Used for SIS integration. |
| SISIntegrationInitiative |
The form ID. |
| SISMethod |
Deprecated. |
| clevrIntegrationField |
Used for form to form integration. Place on the target form. The value will be the element id from the corresponding field on the source form. |
| clevrIntegrationForm |
Used for form to form integration. Place on the target form. The value will be the form id from the corresponding source form. |
Queries
| Attribute |
Description |
| query |
A database query. Must be handled by clevr developers.
This attribute can only be edited or viewed by clevr Staff. |
| row_type |
Describes the query column name that will beplaced in either the dropdown text or value.
This attribute can only be edited or viewed by clevr Staff. |
| preventQueryOnValue |
The query will not run once the field has a value |
Autocompletes
| Attribute |
Description |
| acQuery |
This will hold the query for the persons you want selectable in the autocomplete.
This attribute can only be edited or viewed by clevr Staff. |
| acMustMatch |
Indicates if the the entered value must match one of the values in the list or if data not in the list can be entered and saved.
Potentially only used with comma-separated (depriciated) & XML autocompletes. |
| acNotMatch |
Callback attribute when the value doesn’t match, not 100% though. |
| acQueryFieldName |
The name of a described result in the acQuery. The result will be brought into the element as a value. |
| acQuerySource |
The element id of the autocomplete textbox. Connects the autocomplete to another field. |
| setOtherFields |
When set to true, allows for acQueryFieldName and acQuerySource to be used to saved queried data into a separate field from the autocomplete. |
| callback |
Used to run a function after a selection has been made & the autocomplete population fields (if any) have been populated. |
| searchFields |
Holds the fields displayed in the student autocomplete from the queried tables.
This attribute can only be edited or viewed by clevr Staff. |
| XMLFile |
Name of the XML files that contains the information for the autocomplete. |
Platform Features
| Attribute |
Description |
| bulkDataEntry |
The value must be the form id. Allows for the field to have data entered through the bulk data entry module. |
| checkPII |
This attribute flags a field to prevent Personally Identifiable Information from being entered. The element will fail to save if it contains that type of information for the current person. Personally Identifiable Information can include things such as name or identification numbers. |
| searchable |
The value must be the form id. Allows for the field to be searchable in the listings and advanced search. |
| shadowId |
The value must be the element id of the source element. The value from the source element will be brought into the target element on tab load. If the tab is already loaded, then the page will have to be refreshed to bring the value into the target field.
This element should be accompanied with the class = “unhook”. |
| show-if-locked |
When set to true, the element will be displayed even if the form is locked. This is used to display elements such as hovertips which disappear when locked if that behaviour is unwanted. |
| DoNotClone |
If set to true, the element will not clone it’s value when the record is cloned. |
| filterSort |
Used to determine the order in which elements are sorted for actions such as importing/exporting form data. |
| pageType |
Sets the menu used when viewing the form. The current supported values are “template” and “templateFrench”. |
| positioner |
Must be set to on in order for some features to function correctly without the need for relative positioning (i.e., repeaters, clevrShowHide) |
| GridViewDataEntry |
The value must be the form id. Allows for the field to have data entered through the grid view data entry module. |
Required Fields
| Attribute |
Description |
| isRequired |
The value must be the form id. All required fields must have data entered into them in order to reach 100% in the completion meter. |
| showStatusIndicator |
Must be applied to the typeID 0 container. Must be set to true. Required if required fields are configured on the form. Will display a completion meter at the top of the form |
| required-message_en-CA |
This is an unused feature, allows you to attach a message to the required field in the player.required object. All account language settings will use this as a default. |
| required-message_fr-CA |
This is an unused feature, that allows you to attach a message to the required field in the player.required object, with the language set to French. |
| required-message_es-US |
This is an unused feature, that allows you to attach a message to the required field in the player.required object, with the language set to Spanish. |
| required-sort |
Sets the value of the sort data in the player.required object. Can be used to order the data when reading the player.required object with javascript. |
Dashboard
| Attribute |
Description |
| dashboardInitiative |
Current form id. |
| dashboardMetric |
Matching criteria for the dashboard metric. This value will cause the metric to count the number of records that match this criteria. Can be a list of values (ie: Level 2;Level 3 will count records that contain Level 2 OR Level 3 in the Funding Level field) |
| dashboardMetricLabel |
Label to appear on the dashboard. This is required. |
| hide-metrics-all-records |
Set on the form root typeId 0, if the value is true, it hides the total number of records info in the metrics card on the dashboard. |
| hide-metrics-completed |
Set on the form root typeId 0, if the value is true, it hides the incompleted number of records info in the metrics card on the dashboard. |
| hide-metrics-uncompleted |
Set on the form root typeId 0, if the value is true, it hides the completed number of records info in the metrics card on the dashboard. |
Track Fields
| Attribute |
Description |
| trackFormFields |
Must be applied to the typeId 0 container. The value must be true. Allows for trackField to be used. |
| trackField |
The value must be the form id. Allows for field to be read even if the tab it is on has not been loaded yet. |
Element Attributes
| Attribute |
Description |
| description_en-CA |
The description of an element. All account language settings will use this as a default. |
| description_fr-CA |
The description of an element for accounts with the language set to French. |
| description_es-US |
The description of an element for accounts with the language set to Spanish. |
| title_en-CA |
Language-supported title tag for images and browser tooltips. |
| title_fr-CA |
Language-supported title tag for images and browser tooltips, for French. |
| title_es-US |
Language-supported title tag for images and browser tooltips, for Spanish. |
Content/Language
| Attribute |
Description |
| content_en-CA |
The text that will display in an element. Should be used for text elements only. All account language settings will use this as a default. |
| content_fr-CA |
The text that will display in an element for accounts with the language set to French. Should be used for text elements only. |
| content_es-US |
The text that will display in an element for accounts with the language set to Spanish. Should be used for text elements only. |
Textbox (Input Validation)
| Attribute |
Description |
| regular-expression |
A regulare expression that describes the conditions that data must follow when being input into a field in order for it to be saved. |
| number-format |
Controls how numbers will be displayed once input into a field. The amount of digits input into the field must match the number of digits used in the value of this attribute. |
| format-message |
The error message for validated fields. |
Drop-Down
| Attribute |
Description |
| optionList |
The list of options for the drop-down |
| optionsListFunction |
Deprecated |
| optionsListIDs |
Deprecated |
| optionsListLookUp |
Deprecated |
| functionName |
Deprecated |
| debugOptionFunction |
Deprecated |
Checkbox
| Attribute |
Description |
| extend |
The element id of a field in order to connect them for reporting purposes. |
Datepickers
| Attribute |
Description |
| date-format |
Controls how the date will be displayed once selected in the datepicker |
| is-date-picker |
If the element is a textbox, but contains date data, this flag will indicate to the dashboard to treat this element as a datepicker. |
Repeater
| Attribute |
Description |
| repeatable |
Is applied by default to a specific container in the repeater custom type. This allows for that container to be repeated when the “Add” for the repeater is selected. This should not be used outside of a repeater. |
| stretch |
Is applied by default to a specific container in the repeater custom type. Allows for that container to grow and push the following elements on the form down when a repeater instance is added. This should not be used outside of a repeater. |
| dynamic-limit |
Sets the max number of repeater instances that are allowed. Used to set this limit dynamically.
(The smaller of the max-limit & dynamic-limit values will be used as the true limit) |
| max-limit |
Sets the max number of repeater instances that are allowed.
(The smaller of the max-limit & dynamic-limit values will be used as the true limit) |
Container
| Attribute |
Description |
| pos-rel |
Deprecated |
| new-top |
Deprecated |
Tabset
| Attribute |
Description |
| label_en-CA |
The text on the tab button. All account language settings will use this as a default. |
| label_fr-CA |
The text on the tab button for accounts with the language set to French. |
| label_es-US |
The text on the tab button for accounts with the language set to Spanish. |
| dynamicLabel |
Links the tab label to the value of a field on the form. |
Bullet / Numbered List
| Attribute |
Description |
| item# |
This attribute will need to be added for each item in the list. The pound symbol in the attribute should be replaced with a number. The number should increase by 1 for each item in the list/each time the attribute is applied on a single element. |
Email Contact
| Attribute |
Description |
| email-subject |
Sets the email subject for the Email Contact custom type. Can be dynamically set via Javascript. |
| email-body |
Sets the email body for the Email Contact custom type. Can be dynamically set via Javascript. |
Navigate to Form
| Attribute |
Description |
| formLinkID |
Form id of the form that the user will navigate to onclick. |
| formLinkNewRecord |
When set to true, navigating to the specified form by clicking this element will also generate a new record.
When set to false or not included, a new record will be created only if one does not exist already, otherwise it will navigate to the existing active or locked record.
Newly created records will automatically pull from the SIS to populate the flagged SIS fields.
(Not a required attribute, false by default) |
| formLinkUserRec |
When set to true, it will create a record for the user and not the person of the form.
When used in conjunction with formLinkNewRecord, it will always create a new record regardless if one already exists.
Newly created records will automatically pull from the SIS to populate the flagged SIS fields.
(Not a required attribute, false by default) |
clevrShowHide
| Attribute |
Description |
| order |
The order of the fields controlled by the clevrShowHide() described in a semi-colon delimited list. |
| level |
The depth of the clevrShowHide() ascending numerically |
HoverTips
| Attribute |
Description |
| bighovertip |
Displays an information bubble when the user hovers over the element in a large box. |
| biginfo |
Alternative hovertip. |
| hovertip |
Displays an information bubble when the user hovers over the element. |
| tooltip |
Alternative hovertip. |
Miscellaneous
| Attribute |
Description |
| col |
The number of columns wide an element will be. |
| notificationAction |
Used for checkbox notifications. Sends the described notification when triggered. |
| orderBy |
Deprecated. |
