You are here

Home » API reference » YAML Form 8

yamlform.schema.yml in YAML Form 8

config/schema/yamlform.schema.yml

File

config/schema/yamlform.schema.yml
View source 
  1. # Schema for the configuration files of the YAML Form module.

  2. 

  3. yamlform.settings:

  4.   type: config_object

  5.   label: 'Form settings'

  6.   mapping:

  7.     settings:

  8.       type: mapping

  9.       label: 'Form default settings'

  10.       mapping:

  11.         default_page_base_path:

  12.           type: string

  13.           label: 'Default base path'

  14.         default_form_submit_label:

  15.           type: label

  16.           label: 'Default form submit text'

  17.         default_form_closed_message:

  18.           type: text

  19.           label: 'Default form closed message'

  20.         default_form_exception_message:

  21.           type: text

  22.           label: 'Default form exception message'

  23.         default_form_confidential_message:

  24.           type: text

  25.           label: 'Default form confidential message'

  26.         default_form_novalidate:

  27.           type: boolean

  28.           label: 'Disable client-side validation'

  29.         default_form_unsaved:

  30.           type: boolean

  31.           label: 'Warn users about unsaved changes'

  32.         default_form_disable_back:

  33.           type: boolean

  34.           label: 'Disable back button'

  35.         default_form_details_toggle:

  36.           type: boolean

  37.           label: 'Display collapse/expand all details link'

  38.         default_wizard_prev_button_label:

  39.           type: label

  40.           label: 'Default wizard previous page button label'

  41.         default_wizard_next_button_label:

  42.           type: label

  43.           label: 'Default wizard next page button label'

  44.         default_wizard_start_label:

  45.           type: label

  46.           label: 'Default wizard start label'

  47.         default_wizard_complete_label:

  48.           type: label

  49.           label: 'Default wizard complete label'

  50.         default_preview_next_button_label:

  51.           type: label

  52.           label: 'Default preview button label'

  53.         default_preview_prev_button_label:

  54.           type: label

  55.           label: 'Default preview previous page button label'

  56.         default_preview_message:

  57.           type: text

  58.           label: 'Default preview message'

  59.         default_draft_button_label:

  60.           type: label

  61.           label: 'Default draft button label'

  62.         default_draft_saved_message:

  63.           type: text

  64.           label: 'Default draft save message'

  65.         default_draft_loaded_message:

  66.           type: text

  67.           label: 'Default draft load message'

  68.         default_confirmation_message:

  69.           type: text

  70.           label: 'Default confirmation message'

  71.         default_confirmation_back_label:

  72.           type: text

  73.           label: 'Default confirmation back label'

  74.         default_limit_total_message:

  75.           type: text

  76.           label: 'Default limit total message'

  77.         default_limit_user_message:

  78.           type: text

  79.           label: 'Default limit user message'

  80.         form_classes:

  81.           type: string

  82.           label: 'Form CSS classes'

  83.         button_classes:

  84.           type: string

  85.           label: 'Button CSS classes'

  86.         confirmation_classes:

  87.           type: string

  88.           label: 'Confirmation CSS classes'

  89.         confirmation_back_classes:

  90.           type: string

  91.           label: 'Confirmation back link CSS classes'

  92.     elements:

  93.       type: mapping

  94.       label: 'Elements default settings'

  95.       mapping:

  96.         allowed_tags:

  97.           type: string

  98.           label: 'Allowed tags'

  99.         wrapper_classes:

  100.           type: string

  101.           label: 'Wrapper CSS classes'

  102.         classes:

  103.           type: string

  104.           label: 'Element CSS classes'

  105.         default_description_display:

  106.           type: string

  107.           label: 'Default title display'

  108.         default_google_maps_api_key:

  109.           type: string

  110.           label: 'Default Google Maps API key'

  111.         excluded_types:

  112.           type: ignore

  113.           label: 'Excluded types'

  114.     file:

  115.       type: mapping

  116.       label: 'File upload default settings'

  117.       mapping:

  118.         file_public:

  119.           type: boolean

  120.           label: 'Allow files to be uploaded to public file system.'

  121.         default_max_filesize:

  122.           type: string

  123.           label: 'Default maximum upload size'

  124.         default_managed_file_extensions:

  125.           type: string

  126.           label: 'Default allowed managed file extensions'

  127.         default_image_file_extensions:

  128.           type: string

  129.           label: 'Default allowed image file extensions'

  130.         default_video_file_extensions:

  131.           type: string

  132.           label: 'Default allowed video file extensions'

  133.         default_audio_file_extensions:

  134.           type: string

  135.           label: 'Default allowed audio file extensions'

  136.         default_document_file_extensions:

  137.           type: string

  138.           label: 'Default allowed document file extensions'

  139.     format:

  140.       type: ignore

  141.       label: 'Format default settings'

  142.     mail:

  143.       type: mapping

  144.       label: 'Email default settings'

  145.       mapping:

  146.         default_from_mail:

  147.           type: email

  148.           label: 'Default email from address'

  149.         default_from_name:

  150.           type: label

  151.           label: 'Default email from name'

  152.         default_subject:

  153.           type: label

  154.           label: 'Default email subject'

  155.         default_body_text:

  156.           type: text

  157.           label: 'Default email body (Plain text)'

  158.         default_body_html:

  159.           type: text

  160.           label: 'Default email body (HTML)'

  161.     export:

  162.       type: mapping

  163.       label: 'Export default settings'

  164.       mapping:

  165.         exporter:

  166.           type: string

  167.           label: 'Results exporter'

  168.         delimiter:

  169.           type: string

  170.           label: 'Delimiter text format'

  171.         excel:

  172.           type: boolean

  173.           label: 'Open HTML table in Excel'

  174.         file_name:

  175.           type: string

  176.           label: 'File name'

  177.         header_format:

  178.           type: string

  179.           label: 'Column header format'

  180.         header_prefix:

  181.           type: boolean

  182.           label: 'Column header prefix'

  183.         header_prefix_key_delimiter:

  184.           type: string

  185.           label: 'Column header prefix key delimiter'

  186.         header_prefix_label_delimiter:

  187.           type: string

  188.           label: 'Column header prefix label delimiter'

  189.         entity_reference_format:

  190.           type: string

  191.           label: 'Options format'

  192.         options_format:

  193.           type: string

  194.           label: 'Options item format'

  195.         options_item_format:

  196.           type: string

  197.           label: 'Entity reference format'

  198.         likert_answers_format:

  199.           type: string

  200.           label: 'Likert answers format'

  201.         signature_format:

  202.           type: string

  203.           label: 'Signature format'

  204.         composite_element_item_format:

  205.           type: string

  206.           label: 'Composite element item format'

  207.     batch:

  208.       type: mapping

  209.       label: 'Batch settings'

  210.       mapping:

  211.         default_batch_export_size:

  212.           type: integer

  213.           label: 'Batch export size'

  214.         default_batch_update_size:

  215.           type: integer

  216.           label: 'Batch update size'

  217.         default_batch_delete_size:

  218.           type: integer

  219.           label: 'Batch delete size'

  220.     test:

  221.       type: mapping

  222.       label: 'Test settings'

  223.       mapping:

  224.         types:

  225.           type: text

  226.           label: 'Test types'

  227.         names:

  228.           type: text

  229.           label: 'Test names'

  230.     ui:

  231.       type: mapping

  232.       label: 'User interface settings'

  233.       mapping:

  234.         video_display:

  235.           type: string

  236.           label: 'Video display'

  237.         dialog_disabled:

  238.           type: boolean

  239.           label: 'Disable dialogs'

  240.         html_editor_disabled:

  241.           type: boolean

  242.           label: 'Disable HTML editor'

  243.         details_save:

  244.           type: boolean

  245.           label: 'Save details open/close state'

  246.     library:

  247.       type: mapping

  248.       label: 'Library settings'

  249.       mapping:

  250.         cdn:

  251.           type: boolean

  252.           label: 'Use CDN'

  253.     third_party_settings:

  254.       type: sequence

  255.       label: 'Third party settings'

  256.       sequence:

  257.         type: yamlform.admin_settings.third_party.[%key]

  258. 

  259. yamlform.yamlform.*:

  260.   type: config_entity

  261.   label: 'Forms'

  262.   mapping:

  263.     status:

  264.       type: boolean

  265.       label: 'Status'

  266.     uid:

  267.       type: integer

  268.       label: 'Author'

  269.     template:

  270.       type: boolean

  271.       label: 'Template'

  272.     id:

  273.       type: string

  274.       label: 'Machine name'

  275.     title:

  276.       type: label

  277.       label: 'Title'

  278.     description:

  279.       type: label

  280.       label: 'Administrative description'

  281.     elements:

  282.       type: text

  283.       label: 'Elements (YAML)'

  284.     css:

  285.       type: string

  286.       label: 'CSS (Cascading Style Sheets)'

  287.     javascript:

  288.       type: string

  289.       label: 'JavaScript'

  290.     settings:

  291.       type: mapping

  292.       label: 'Settings'

  293.       mapping:

  294.         page:

  295.           type: boolean

  296.           label: 'Enable page'

  297.         page_submit_path:

  298.           type: string

  299.           label: 'Page submit URL alias'

  300.         page_confirm_path:

  301.           type: string

  302.           label: 'Page confirm URL alias'

  303.         form_submit_label:

  304.           type: label

  305.           label: 'Form submit text'

  306.         form_submit_attributes:

  307.           type: ignore

  308.           label: 'Form submit attributes'

  309.         form_closed_message:

  310.           type: text

  311.           label: 'Form closed message'

  312.         form_exception_message:

  313.           type: text

  314.           label: 'Form exception message'

  315.         form_confidential:

  316.           type: boolean

  317.           label: 'Form confidential'

  318.         form_confidential_message:

  319.           type: text

  320.           label: 'Form confidential message'

  321.         form_prepopulate:

  322.           type: boolean

  323.           label: 'Form prepopulate elements'

  324.         form_prepopulate_source_entity:

  325.           type: boolean

  326.           label: 'Form prepopulate source entity'

  327.         form_unsaved:

  328.           type: boolean

  329.           label: 'Warn users about unsaved changes'

  330.         form_disable_back:

  331.           type: boolean

  332.           label: 'Disable back button'

  333.         form_novalidate:

  334.           type: boolean

  335.           label: 'Disable client-side validation'

  336.         form_autofocus:

  337.           type: boolean

  338.           label: 'Autofocus'

  339.         form_details_toggle:

  340.           type: boolean

  341.           label: 'Display collapse/expand all details link'

  342.         wizard_progress_bar:

  343.           type: boolean

  344.           label: 'Show wizard progress bar'

  345.         wizard_progress_pages:

  346.           type: boolean

  347.           label: 'Show wizard progress pages'

  348.         wizard_progress_percentage:

  349.           type: boolean

  350.           label: 'Show wizard progress pages'

  351.         wizard_start_label:

  352.           type: label

  353.           label: 'Wizard start label'

  354.         wizard_start_attributes:

  355.           type: ignore

  356.           label: 'Wizard start attributes'

  357.         wizard_complete:

  358.           type: boolean

  359.           label: 'Include confirmation page in progress'

  360.         wizard_complete_label:

  361.           type: label

  362.           label: 'Wizard complete label'

  363.         wizard_prev_button_label:

  364.           type: label

  365.           label: 'Wizard previous page button label'

  366.         wizard_prev_button_attributes:

  367.           type: ignore

  368.           label: 'Wizard previous page button attributes'

  369.         wizard_next_button_label:

  370.           type: label

  371.           label: 'Wizard next page button label'

  372.         wizard_next_button_attributes:

  373.           type: ignore

  374.           label: 'Wizard next page button attributes'

  375.         preview:

  376.           type: integer

  377.           label: 'Enable preview page'

  378.         preview_next_button_label:

  379.           type: label

  380.           label: 'Preview button label'

  381.         preview_next_button_attributes:

  382.           type: ignore

  383.           label: 'Preview button attributes'

  384.         preview_prev_button_label:

  385.           type: label

  386.           label: 'Previous page button label'

  387.         preview_prev_button_attributes:

  388.           type: ignore

  389.           label: 'Previous page button attributes'

  390.         preview_message:

  391.           type: text

  392.           label: 'Preview message'

  393.         draft:

  394.           type: boolean

  395.           label: 'Allow your users to save and finish the form later.'

  396.         draft_auto_save:

  397.           type: boolean

  398.           label: 'Automatically save as draft when previewing and when there are validation errors.'

  399.         draft_button_label:

  400.           type: label

  401.           label: 'Draft button label'

  402.         draft_button_attributes:

  403.           type: ignore

  404.           label: 'Draft button attributes'

  405.         draft_saved_message:

  406.           type: text

  407.           label: 'Draft saved message'

  408.         draft_loaded_message:

  409.           type: text

  410.           label: 'Draft loaded message'

  411.         confirmation_type:

  412.           type: string

  413.           label: 'Confirmation type'

  414.         confirmation_url:

  415.           type: string

  416.           label: 'Confirmation URL'

  417.         confirmation_message:

  418.           type: text

  419.           label: 'Confirmation message'

  420.         confirmation_attributes:

  421.           type: ignore

  422.           label: 'Confirmation attributes'

  423.         confirmation_back:

  424.           type: boolean

  425.           label: 'Display back to form link.'

  426.         confirmation_back_label:

  427.           type: text

  428.           label: 'Confirmation back link label'

  429.         confirmation_back_attributes:

  430.           type: ignore

  431.           label: 'Confirmation back link attributes'

  432.         limit_total:

  433.           type: integer

  434.           label: 'Limit total submissions'

  435.         limit_total_message:

  436.           type: text

  437.           label: 'Limit total message'

  438.         limit_user:

  439.           type: integer

  440.           label: 'Limit user submissions'

  441.         limit_user_message:

  442.           type: text

  443.           label: 'Limit user message'

  444.         entity_limit_total:

  445.           type: integer

  446.           label: 'Entity limit total submissions'

  447.         entity_limit_user:

  448.           type: integer

  449.           label: 'Entity limit user submissions'

  450.         results_disabled:

  451.           type: boolean

  452.           label: 'Results disabled'

  453.         results_disabled_ignore:

  454.           type: boolean

  455.           label: 'Ignore disabled results warning'

  456.         token_update:

  457.           type: boolean

  458.           label: 'Allow updates using token'

  459.     access:

  460.       type: mapping

  461.       label: 'Access'

  462.       mapping:

  463.         create:

  464.           type: mapping

  465.           label: 'Create form submissions'

  466.           mapping:

  467.             roles:

  468.               type: sequence

  469.               label: 'Roles'

  470.               sequence:

  471.                 type: string

  472.                 label: 'Role'

  473.             users:

  474.               type: sequence

  475.               label: 'Users'

  476.               sequence:

  477.                 type: integer

  478.                 label: 'User IDs'

  479.         view_any:

  480.           type: mapping

  481.           label: 'View any form submissions'

  482.           mapping:

  483.             roles:

  484.               type: sequence

  485.               label: 'Roles'

  486.               sequence:

  487.                 type: string

  488.                 label: 'Role'

  489.             users:

  490.               type: sequence

  491.               label: 'Users'

  492.               sequence:

  493.                 type: integer

  494.                 label: 'User IDs'

  495.         update_any:

  496.           type: mapping

  497.           label: 'Update any form submissions'

  498.           mapping:

  499.             roles:

  500.               type: sequence

  501.               label: 'Roles'

  502.               sequence:

  503.                 type: string

  504.                 label: 'Role'

  505.             users:

  506.               type: sequence

  507.               label: 'Users'

  508.               sequence:

  509.                 type: integer

  510.                 label: 'User IDs'

  511.         delete_any:

  512.           type: mapping

  513.           label: 'Delete any form submissions'

  514.           mapping:

  515.             roles:

  516.               type: sequence

  517.               label: 'Roles'

  518.               sequence:

  519.                 type: string

  520.                 label: 'Role'

  521.             users:

  522.               type: sequence

  523.               label: 'Users'

  524.               sequence:

  525.                 type: integer

  526.                 label: 'User IDs'

  527.         purge_any:

  528.           type: mapping

  529.           label: 'Purge any form submissions'

  530.           mapping:

  531.             roles:

  532.               type: sequence

  533.               label: 'Roles'

  534.               sequence:

  535.                 type: string

  536.                 label: 'Role'

  537.             users:

  538.               type: sequence

  539.               label: 'Users'

  540.               sequence:

  541.                 type: integer

  542.                 label: 'User IDs'

  543.         view_own:

  544.           type: mapping

  545.           label: 'View own form submissions'

  546.           mapping:

  547.             roles:

  548.               type: sequence

  549.               label: 'Roles'

  550.               sequence:

  551.                 type: string

  552.                 label: 'Role'

  553.             users:

  554.               type: sequence

  555.               label: 'Users'

  556.               sequence:

  557.                 type: integer

  558.                 label: 'User IDs'

  559.         update_own:

  560.           type: mapping

  561.           label: 'Update own form submissions'

  562.           mapping:

  563.             roles:

  564.               type: sequence

  565.               label: 'Roles'

  566.               sequence:

  567.                 type: string

  568.                 label: 'Role'

  569.             users:

  570.               type: sequence

  571.               label: 'Users'

  572.               sequence:

  573.                 type: integer

  574.                 label: 'User IDs'

  575.         delete_own:

  576.           type: mapping

  577.           label: 'Delete own form submissions'

  578.           mapping:

  579.             roles:

  580.               type: sequence

  581.               label: 'Roles'

  582.               sequence:

  583.                 type: string

  584.                 label: 'Role'

  585.             users:

  586.               type: sequence

  587.               label: 'Users'

  588.               sequence:

  589.                 type: integer

  590.                 label: 'User IDs'

  591.     handlers:

  592.       type: sequence

  593.       label: 'Form handlers'

  594.       sequence:

  595.         type: mapping

  596.         mapping:

  597.           id:

  598.             type: string

  599.           handler_id:

  600.             type: string

  601.           label:

  602.             type: label

  603.           status:

  604.             type: boolean

  605.           weight:

  606.             type: integer

  607.           settings:

  608.             type: yamlform.handler.[%parent.id]

  609.     third_party_settings:

  610.       type: sequence

  611.       label: 'Third party settings'

  612.       sequence:

  613.         type: yamlform.settings.third_party.[%key]

  614. 

  615. yamlform.handler.*:

  616.   type: mapping

  617.   label: 'Handler settings'

  618. 

  619. yamlform.handler.email:

  620.   type: mapping

  621.   label: 'Email'

  622.   mapping:

  623.     to_mail:

  624.       label: 'Email to address'

  625.       type: email

  626.     bcc_mail:

  627.       label: 'Email Bcc address'

  628.       type: email

  629.     cc_mail:

  630.       label: 'Email Cc address'

  631.       type: email

  632.     from_mail:

  633.       label: 'Email from address'

  634.       type: email

  635.     from_name:

  636.       label: 'Email from name'

  637.       type: label

  638.     subject:

  639.       label: 'Email subject'

  640.       type: label

  641.     body:

  642.       label: 'Email body'

  643.       type: text

  644.     excluded_elements:

  645.       type: sequence

  646.       label: 'Exclude elements'

  647.       sequence:

  648.         type: string

  649.         label: 'Element name'

  650.     html:

  651.       type: boolean

  652.       label: 'HTML'

  653.     attachments:

  654.       type: boolean

  655.       label: 'Attachments'

  656.     debug:

  657.       type: boolean

  658.       label: 'Enable debugging'

  659. 

  660. yamlform.handler.remote_post:

  661.   type: mapping

  662.   label: 'Remote Post'

  663.   mapping:

  664.     type:

  665.       label: 'Type'

  666.       type: string

  667.     insert_url:

  668.       label: 'Insert URL'

  669.       type: uri

  670.     update_url:

  671.       label: 'Update URL'

  672.       type: uri

  673.     delete_url:

  674.       label: 'Delete URL'

  675.       type: uri

  676.     excluded_data:

  677.       type: sequence

  678.       label: 'Excluded data'

  679.       sequence:

  680.         type: string

  681.         label: 'Data name'

  682.     custom_data:

  683.       label: 'Custom data'

  684.       type: string

  685.     insert_custom_data:

  686.       label: 'Insert custom data'

  687.       type: string

  688.     update_custom_data:

  689.       label: 'Update custom data'

  690.       type: string

  691.     delete_custom_data:

  692.       label: 'Delete custom data'

  693.       type: string

  694.     debug:

  695.       type: boolean

  696.       label: 'Enable debugging'

  697. 

  698. yamlform.exporter.*:

  699.   type: mapping

  700.   label: 'Exporter settings'

  701. 

  702. yamlform.exporter.delimited_text:

  703.   type: mapping

  704.   label: 'Delimiter'

  705.   mapping:

  706.     delimiter:

  707.       type: string

  708.       label: 'Delimiter'

  709. 

  710. yamlform.yamlform_options.*:

  711.   type: config_entity

  712.   label: 'Options'

  713.   mapping:

  714.     id:

  715.       type: string

  716.       label: 'Machine name'

  717.     label:

  718.       type: label

  719.       label: 'Label'

  720.     options:

  721.       type: text

  722.       label: 'Options (YAML)'

  723. 

  724. block.settings.yamlform_block:

  725.   type: block_settings

  726.   label: 'Forms block'

  727.   mapping:

  728.     yamlform_id:

  729.       type: text

  730.       label: 'Forms'

  731.     default_data:

  732.       type: text

  733.       label: 'Default form submission data'

  734. 

  735. # Schema for the configuration of the form field type.

  736. 

  737. field.storage_settings.yamlform:

  738.   type: mapping

  739.   label: 'Form field storage settings'

  740.   mapping:

  741.     target_type:

  742.       type: string

  743.       label: 'Type of item to reference'

  744. 

  745. base_yamlform_field_field_settings:

  746.   type: mapping

  747.   mapping:

  748.     handler:

  749.       type: string

  750.       label: 'Reference method'

  751.     handler_settings:

  752.       type: entity_reference_selection.[%parent.handler]

  753.       label: 'Entity reference selection settings'

  754. 

  755. field.field_settings.yamlform:

  756.   type: base_yamlform_field_field_settings

  757.   label: 'Form settings'

  758.   mapping:

  759.     default_data:

  760.       type: string

  761.       label: 'Default form submission data'

  762.     status:

  763.       type: boolean

  764.       label: 'Status of the form'

  765. 

  766. field.widget.settings.yamlform_entity_reference_autocomplete:

  767.   type: mapping

  768.   label: 'Form autocomplete display format settings'

  769.   mapping:

  770.     match_operator:

  771.       type: string

  772.       label: 'Autocomplete matching'

  773.     size:

  774.       type: integer

  775.       label: 'Size of textfield'

  776.     placeholder:

  777.       type: label

  778.       label: 'Placeholder'

  779. 

  780. field.formatter.settings.yamlform_entity_reference_entity_view:

  781.   type: mapping

  782.   label: 'Display the referenced form with default submission data.'

  783. 

  784. field.formatter.settings.yamlform_entity_reference_link:

  785.   type: mapping

  786.   label: 'Display the referenced form as a link.'

  787.   mapping:

  788.     label:

  789.       type: label

  790.       label: 'Link label to the referenced form'