You are here

business_rules_action.schema.yml in Business Rules 8

Same filename and directory in other branches
  1. 2.x config/schema/business_rules_action.schema.yml
config/schema/business_rules_action.schema.yml

File

config/schema/business_rules_action.schema.yml
View source
  1. # Business Rules Action.
  2. business_rules.action.*:
  3. type: config_entity
  4. label: 'Action config'
  5. mapping:
  6. id:
  7. type: string
  8. label: 'ID'
  9. label:
  10. type: label
  11. label: 'Label'
  12. uuid:
  13. type: string
  14. description:
  15. type: text
  16. label: 'Description'
  17. type:
  18. type: string
  19. label: 'Type'
  20. target_entity_type:
  21. type: string
  22. label: 'Entity type'
  23. target_bundle:
  24. type: string
  25. label: 'Bundle'
  26. tags:
  27. type: sequence
  28. label: 'Tags'
  29. sequence:
  30. type: string
  31. label: 'Tag'
  32. settings:
  33. type: business_rules.action.type.[%parent.type]
  34. # Action Set.
  35. business_rules.action.type.action_set:
  36. type: mapping
  37. label: 'Action set'
  38. mapping:
  39. items:
  40. type: sequence
  41. label: 'Items'
  42. sequence:
  43. type: business_rules.item
  44. # Delete Entity Action.
  45. business_rules.action.type.delete_entity:
  46. type: mapping
  47. label: 'Delete entity'
  48. mapping:
  49. field:
  50. type: string
  51. label: 'Field'
  52. value:
  53. type: text
  54. label: 'value'
  55. # Display error message on form Action.
  56. business_rules.action.type.display_error_message_on_form:
  57. type: mapping
  58. label: 'Display validation error in a form'
  59. mapping:
  60. field:
  61. type: string
  62. label: 'Field'
  63. message:
  64. type: text
  65. label: 'Message'
  66. # Fetch entity variable Action.
  67. business_rules.action.type.fetch_entity_variable:
  68. type: mapping
  69. label: 'Fetch entity variable'
  70. mapping:
  71. field:
  72. type: string
  73. label: 'Id Field'
  74. value:
  75. type: string
  76. label: 'Id value'
  77. empty_variable:
  78. type: string
  79. label: 'Empty variable to be filled in'
  80. # Fill entity variable fields Action.
  81. business_rules.action.type.fill_entity_variable_fields:
  82. type: mapping
  83. label: 'Fill entity variable fields'
  84. mapping:
  85. variable:
  86. type: string
  87. label: 'Empty variable to be filled in'
  88. fields_values:
  89. type: sequence
  90. label: 'Fields values'
  91. sequence:
  92. type: business_rules.action.type.fill_entity_variable_fields.field_value
  93. # Fill entity variable fields: Fields value mapping.
  94. business_rules.action.type.fill_entity_variable_fields.field_value:
  95. type: mapping
  96. label: 'Field value'
  97. mapping:
  98. entity_field:
  99. type: string
  100. label: 'Field name'
  101. field_value:
  102. type: text
  103. label: 'Field value'
  104. # Page redirect Action.
  105. business_rules.action.type.page_redirect:
  106. type: mapping
  107. label: 'Page redirect'
  108. mapping:
  109. url:
  110. type: string
  111. label: 'Url'
  112. # Publish entity Action.
  113. business_rules.action.type.publish_entity:
  114. type: mapping
  115. label: 'Publish entity'
  116. mapping:
  117. field:
  118. type: string
  119. label: 'Field'
  120. value:
  121. type: text
  122. label: 'value'
  123. # Unpublish entity Action.
  124. business_rules.action.type.unpublish_entity:
  125. type: mapping
  126. label: 'Unpublish entity'
  127. mapping:
  128. field:
  129. type: string
  130. label: 'Field'
  131. value:
  132. type: text
  133. label: 'value'
  134. # Save entity variable Action.
  135. business_rules.action.type.save_entity_variable:
  136. type: mapping
  137. label: 'Save entity variable'
  138. mapping:
  139. variable:
  140. type: string
  141. label: 'Empty variable to be saved'
  142. # Send mail Action.
  143. business_rules.action.type.send_email:
  144. type: mapping
  145. label: 'Send mail'
  146. mapping:
  147. subject:
  148. type: text
  149. label: 'Subject'
  150. use_site_mail_as_sender:
  151. type: boolean
  152. label: 'Use site mail as sender'
  153. from:
  154. type: string
  155. label: 'From'
  156. to:
  157. type: string
  158. label: 'To'
  159. format:
  160. type: string
  161. label: 'Mail format'
  162. body:
  163. type: mapping
  164. label: 'Message body'
  165. mapping:
  166. format:
  167. type: string
  168. label: 'Email body format'
  169. value:
  170. type: text
  171. label: 'Email body value'
  172. # Set field value Action.
  173. business_rules.action.type.set_field_value:
  174. type: mapping
  175. label: 'Set field value'
  176. mapping:
  177. field:
  178. type: string
  179. label: 'Field'
  180. value:
  181. type: text
  182. label: 'value'
  183. # Show a message Action.
  184. business_rules.action.type.show_message:
  185. type: mapping
  186. label: 'Show message'
  187. mapping:
  188. message:
  189. type: text
  190. label: 'Message'
  191. message_type:
  192. type: string
  193. label: 'Message type'
  194. # Loop through a view variable.
  195. business_rules.action.type.loop_through_view_result:
  196. type: mapping
  197. label: 'Loop through a view result variable'
  198. mapping:
  199. variable:
  200. type: string
  201. label: 'Views variable'
  202. items:
  203. type: sequence
  204. label: 'Items'
  205. sequence:
  206. type: business_rules.item
  207. # Loop through a multi-value field variable.
  208. business_rules.action.type.loop_through_field_variable:
  209. type: mapping
  210. label: 'Loop through a multi-value field variable'
  211. mapping:
  212. variable:
  213. type: string
  214. label: 'Views variable'
  215. items:
  216. type: sequence
  217. label: 'Items'
  218. sequence:
  219. type: business_rules.item
  220. # Calculate a value
  221. business_rules.action.type.calculate_value:
  222. type: mapping
  223. label: 'Calculate a value'
  224. mapping:
  225. variable:
  226. type: string
  227. label: 'Variable to store the result'
  228. formula:
  229. type: string
  230. label: 'Formula'
  231. business_rules.action.type.add_user_role:
  232. type: mapping
  233. label: 'Add role to user'
  234. mapping:
  235. user_container:
  236. type: string
  237. label: 'User container' #current|by_id|variable
  238. uid:
  239. type: string
  240. label: 'User id'
  241. variable:
  242. type: string
  243. label: 'User variable' #The variable containing the user. Only variables type: "User variable".
  244. roles:
  245. type: sequence
  246. label: 'Roles'
  247. sequence:
  248. type: string
  249. label: 'Role'
  250. business_rules.action.type.remove_user_role:
  251. type: mapping
  252. label: 'Remove role from user'
  253. mapping:
  254. user_container:
  255. type: string
  256. label: 'User container' #current|by_id|variable
  257. uid:
  258. type: string
  259. label: 'User id'
  260. variable:
  261. type: string
  262. label: 'User variable' #The variable containing the user. Only variables type: "User variable".
  263. roles:
  264. type: sequence
  265. label: 'Roles'
  266. sequence:
  267. type: string
  268. label: 'Role'
  269. business_rules.action.type.change_field_info:
  270. type: mapping
  271. label: 'Change entity form field'
  272. mapping:
  273. fields:
  274. type: sequence
  275. label: 'Fields'
  276. sequence:
  277. type: mapping
  278. mapping:
  279. id:
  280. type: string
  281. label: 'Id'
  282. field:
  283. type: string
  284. label: 'Field'
  285. action:
  286. type: string
  287. label: 'Action'
  288. # TODO create an action to change entity_view mode
  289. business_rules.action.type.change_entity_view:
  290. type: mapping
  291. label: 'Change entity form field'
  292. mapping:
  293. fields:
  294. type: sequence
  295. label: 'Fields'
  296. sequence:
  297. type: mapping
  298. mapping:
  299. id:
  300. type: string
  301. label: 'Id'
  302. display:
  303. type: string
  304. label: 'Display settings'
  305. label:
  306. type: string
  307. label: 'Label settings'
  308. weight:
  309. type: integer
  310. label: 'Weight'
  311. business_rules.action.type.schedule_a_task:
  312. type: mapping
  313. label: 'Schedule a task'
  314. mapping:
  315. identiier:
  316. type: string
  317. label: 'Identifier'
  318. field:
  319. type: string
  320. label: 'Entity Field' #the field in which the time offset will be based on.
  321. time_offset:
  322. type: integer
  323. label: 'Time offset'
  324. time_unit:
  325. type: string
  326. label: 'Time unit'
  327. items:
  328. type: sequence
  329. label: 'Items'
  330. sequence:
  331. type: business_rules.item