Asset Attributes
This chapter outlines the asset attributes for the Custom Form asset within Squiz Matrix.
Bookmarks to the headings on this page:
- Custom Form
- Form Contents
- Form Section
- Form Question Type Text
- Form Question Type File Upload
- Form Question Type Password
- Form Question Type Select
- Form Question Type Tickbox Table
- Form Question Type Date/Time
- Form Question Type Tickbox List
- Form Question Type Country
- Form Question Type Email
- Form Question Type Option List
- Form Question Type Numeric
Custom Form
| Attribute (Type) | Description |
|---|---|
| name (text) | Page Name field input (Details screen) |
| short_name (text) | Page Short Name field input (Details screen) |
Form Contents
| Attribute (Type) | Description |
|---|---|
| actions (serialise) | Submission Actions settings (Submission Actions screen) |
| answer_col_width (html_width) | Answer Width field setting (Form Contents screen) |
| captcha_arc (boolean) | Use CAPTCHA Arc field setting (Form Contents screen) |
| captcha_arc_colour (colour) | CAPTCHA Arc Colour field setting (Form Contents screen) |
| captcha_bgcolour (colour) | CAPTCHA Background Colour field setting (Form Contents screen) |
| captcha_bordercolour (colour) | CAPTCHA Border Colour field setting (Form Contents screen) |
| captcha_font_size (interger) | CAPTCHA Font Size field setting (Form Contents screen) |
| captcha_form_invalid_error_message (text) | Captcha Required Form Error Message field input (Form Contents screen) |
| captcha_height (integer) | CAPTCHA Height field input (Form Contents screen) |
| captcha_include_numbers (boolean) | Include Numbers in CAPTCHA Text field setting (Form Contents screen) |
| captcha_include_uppercase (boolean) | Include Uppercase Letters in CAPTCHA Text field setting (Form Contents screen) |
| captcha_invalid_error_message (text) | Captcha Invalid Error Message field input (Form Contents screen) |
| captcha_length (integer) | CAPTCHA Key Length field input (Form Contents screen) |
| captcha_link_text (text) | CAPTCHA Regen Link Text field input (Form Contents screen) |
| captcha_max_angle (integer) | CAPTCHA Max Angle field input (Form Contents screen) |
| captcha_max_distance (integer) | CAPTCHA Max Distance field input (Form Contents screen) |
| captcha_min_angle (integer) | CAPTCHA Min Angle field input (Form Contents screen) |
| captcha_min_distance (integer) | CAPTCHA Min Distance field input (Form Contents screen) |
| captcha_textcolour (colour) | CAPTCHA Text Colour field input (Form Contents screen) |
| captcha_ttf (assetid) | CAPTCHA Font field setting (Form Contents screen) |
| captcha_use_colours (boolean) | Use CAPTCHA Colours field setting (Form Contents screen) |
| captcha_usefont (boolean) | Use CAPTCHA Font field setting (Form Contents screen) |
| captcha_width (integer) | CAPTCHA Width field input (Form Contents screen) |
| captcha_x_start (integer) | CAPTCHA X Start field input (Form Contents screen) |
| captcha_zoom (integer) | CAPTCHA Character Zoom field input (Form Contents screen) |
| confirmation_page_name (text) | Confirmation Page Name field input (Form Contents screen) |
| form_width (html_width) | Form Width field setting (Form Contents screen) |
| log (boolean) | - |
| log_submissions (boolean) | Log Submissions field setting (Submission Logs screen) |
| mollom_captcha_incorrect_text (text) | Captcha Incorrect Text field input (Mollom) (Form Contents screen) |
| mollom_captcha_regen_link_text (text) | Captcha Regen Link Text field input (Mollom) (Form Contents screen) |
| mollom_questions_to_check (serialise) | Questions To Check field settings (Form Contents screen) |
| mollom_spam_submission_text (text) | Spam Error Message field input (Form Contents screen) |
| mollom_unsure_submission_text (text) | Unsure Error Message field input (Form Contents screen) |
| multi_page (boolean) | Multi-Page? field setting (Form Contents screen) |
| name (text) | Name field input (Details screen) |
| next_button (text) | Next Page Button Text field input (Form Contents screen) |
| next_questionid (integer) | Questions (not attached to a section) - next question ID: (eg. if the last question added to the form is #100:q6, the next question ID will be 7) (Form Contents screen) |
| note_size (text) | Note Text Size field input (Form Contents screen) |
| page_list_format (text) | Page List Entry Format field input (Form Contents screen) |
| previous_button (text) | Previous Page Button Text field input (Form Contents screen) |
| provide_accessible_captcha (boolean) | Provide Accessible CAPTCHA field setting (Form Contents screen) |
| question_col_width (html_width) | Question Width field setting (Form Contents screen) |
| questions (serialise) | Questions (not attached to a section) settings (Form Contentsscreen) |
| receipt_emails_format (email_format) | Receipt Email Format field settings (Email Options screen) |
| receipt_field (assetid) | Receipt Recipient Question field setting (Email Options screen) |
| recipient_emails_format (email_format) | Recipient Email Format field settings (Email Options screen) |
| require_captcha (boolean) | Require CAPTCHA field setting (Form Contents screen) |
| reset_button (text) | Reset Button Text field input (Form Contents screen) |
| reset_button_extras (text) | Reset Button Extras field input (Form Contents screen) |
| save_and_exit_button (text) | Save and Exit Button Text field input (Form Contents screen) |
| save_button (text) | Save Button Text field input (Form Contents screen) |
| save_confirmation_message (text) | Save Confirmation Text field input (Form Contents screen) |
| selective_emails (serialise) | Selective Emails settings (Selective Emails screen) |
| show_results (boolean) | - |
| sort_order (serialise) | Order of the questions in the Current Questions field (Form Contents screen) |
| staf_field (assetid) | STAF Recipient Question field setting (Email Options screen) |
| staf_format (email_format) | STAF Email Format field input (Email Options screen) |
| submission_errors_msg (wysiwyg) | Error Message Format field input (Form Contents screen) |
| submission_expiry_time (duration) | Expire Submissions After field input (Incomplete Submissions screen) |
| submission_warning_time (duration) | Send Remind Email After field input (Incomplete Submissions screen) |
| submit_button (text) | Submit Button Text field input (Form Contents screen) |
| submit_button_extras (text) | Submit Button Extras field input (Form Contents screen) |
| unattached_page_name (text) | "Unattached Questions" Page Name field input (Form Contents screen) |
| use_bodycopy_confirmation (boolean) | Use Bodycopy? / Confirmation Page Contents field setting (Form Contents screen) |
| use_bodycopy_exit (boolean) | Use Bodycopy? / Exit Page Contents field setting (Form Contents screen) |
| use_bodycopy_main (boolean) | Use Bodycopy? / Page Contents field setting (Form Contents screen) |
| use_bodycopy_thank_you (boolean) | Use Bodycopy? / Thank You field setting (Form Contents screen) |
| use_bodycopy_unattached (boolean) | Use Bodycopy? / Unattached Questions Format field setting (Form Contents screen) |
| use_client_side (boolean) | Client-Side Validation field setting (Form Contents screen) |
| use_confirmation_page (boolean) | Use Confirmation Page? field setting (Form Contents screen) |
| use_mollom (boolean) | Use Mollom Spam Check field setting (Form Contents screen) |
| warning_email_format (email_format) | Reminder Email Format field input (Incomplete Submissions screen) |
Form Section
| Attribute (Type) | Description |
|---|---|
| answer_col_width (html_width) | Answer Width field setting (Details screen) |
| name (text) | Name field input (Details screen) |
| next_questionid (integer) | Questions - next question ID: (eg. if the last question added to the form is #100:q6, the next question ID will be 7) (Details screen) |
| question_col_wisth (html_width) | Question Width field setting (Details screen) |
| questions (serialise) | Questions settings (Details screen) |
| section_width (html_width) | Section Width field setting (Details screen) |
| sort_order (serialise) | Order of the questions in the Current Questions field (Form Contents screen) |
Form Question Type Text
| Attribute (Type) | Description |
|---|---|
| cust_required_error (text) | Custom Required Error field input (Details screen) |
| default (text) | Default Value field input (Details screen) |
| extra (text) | Extras field input (Details screen) |
| height (text) | Height field input (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| max (text) | Maxmimum Length field input (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| required (boolean) | - |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
| width (text) | Width field input (Details screen) |
Form Question Type File Upload
| Attribute (Type) | Description |
|---|---|
| attach_to_mail (boolean) | Attach to Emails field setting (Details screen) |
| create_location (assetid) | Create Location field setting (Details screen) |
| cust_required_error (text) | Custom Required Error field input (Details screen) |
| extra (text) | Extras field input (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| overwrite_rule (selection) | Overwrite Rule field setting (Details screen) |
| required (boolean) | - |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
Form Question Type Password
| Attribute (Type) | Description |
|---|---|
| cust_required_error (text) | Custom Required Error field input (Details screen) |
| default (text) | Default field input (Details screen) |
| extra (text) | Extras field input (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| max (text) | Maxmimum Length field input (Details screen) |
| min (text) | Minimum Length field input (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
| verify (boolean) | Required Verification field setting (Details screen) |
| width (text) | Width field input (Details screen) |
Form Question Type Select
| Attribute (Type) | Description |
|---|---|
| allow_empty (boolean) | Allow Empty Option? field setting (Details screen) |
| cust_required_error (text) | Custom Required Error field input (Details screen) |
| default (serialise) | Default field selection (Details screen) |
| empty_key (text) | Empty Text Key field input (Details screen) |
| empty_text (text) | Empty Text field input (Details screen) |
| extra (text) | Extras field input (Details screen) |
| height (text) | Height field input (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| multiple (boolean) | Multiple? field setting (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| options (serialise) | Options field input(s) (Details screen) |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
Form Question Type Tickbox Table
| Attribute (Type) | Description |
|---|---|
| cust_required_error (text) | Custom Required Error field input (Details screen) |
| default (text) | - |
| extra (text) | Extras field input (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| question_contents (serialise) | Question Contents field input(s) (Details screen) |
| required (boolean) | - |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
Form Question Type Date/Time
| Attribute (Type) | Description |
|---|---|
| circa (boolean) | |
| cust_required_error (text) | Custom Error Message field input (Details screen) |
| default (datetime) | Default field setting (Details screen) |
| extra (text) | - |
| extras (serialise) | Extras field input(s) (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| maximum (datetime) | Maximum field setting (Details screen) |
| minimum (datetime) | Minimum field setting (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| null (serialise) | Options / Allow Blank? field setting(s) (Details screen) |
| print_format (text) | Print Format field input (Details screen) |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| show (serialise) | Options / Show? field setting(s) (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
| text (serialise) | Options / Display as Text Box? field setting(s) (Details screen) |
Form Question Type Tickbox List
| Attribute (Type) | Description |
|---|---|
| cust_required_error (text) | Custom Error Message field input (Details screen) |
| default (serialise) | Default field setting (Details screen) |
| extra (text) | Extras field input (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| options (option_list) | Options field input(s) (Details screen) |
| required (boolean) | - |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
Form Question Type Country
| Attribute (Type) | Description |
|---|---|
| allow_empty (boolean) | - |
| available (serialise) | Available Countries field settings (Details screen) |
| cust_required_error (text) | Custom Error Message field input (Details screen) |
| default (text) | Default field setting (Details screen) |
| empty_key (text) | - |
| empty_text (text) | - |
| extra (text) | Extras field input (Details screen) |
| height (text) | Options field input(s) (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| multiple (boolean) | Multple? field setting (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| options (serialise) | - |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
| width (text) | - |
Form Question Type Email
| Attribute (Type) | Description |
|---|---|
| cust_required_error (text) | Custom Error Message field input (Details screen) |
| default (text) | Default Value field input (Details screen) |
| extra (text) | Extras field input (Details screen) |
| height (text) | Height field input (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| max (text) | Maximum Length field input (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| required (boolean) | - |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
| width (text) | Width field input (Details screen) |
Form Question Type Option List
| Attribute (Type) | Description |
|---|---|
| cust_required_error (text) | Custom Error Message field input (Details screen) |
| default (text) | Default field setting (Details screen) |
| extra (text) | Extras field input (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| options (option_list) | Options field inputs (Details screen) |
| required (boolean) | - |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
Form Question Type Numeric
| Attribute (Type) | Description |
|---|---|
| cust_required_error (text) | Custom Error Message field input (Details screen) |
| default (text) | Default Value field input (Details screen) |
| extra (text) | Extras field input (Details screen) |
| height (text) | Height field input (Details screen) |
| is_int (boolean) | Enforce Integer field setting (Details screen) |
| is_required (boolean) | Required Entry? field setting (Details screen) |
| max (text) | Maximum Length field input (Details screen) |
| name (text) | Title field input (Details screen) |
| note (text) | Note field input (Details screen) |
| required (boolean) | - |
| rules (serialise) | Complex Validation Rules settings (Details screen) |
| sticky (boolean) | Sticky field setting (Details screen) |
| tabindex (integer) | Tab Index field input (Details screen) |
| width (text) | Width field input (Details screen) |