{"id":24058,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/estop-1\/"},"modified":"2025-02-13T13:04:26","modified_gmt":"2025-02-13T21:04:26","slug":"estop-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/","title":{"rendered":"ESTOP"},"content":{"rendered":"<p><code>{ESTOP: target_field_name,<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; field_value = <em>field_value<\/em><br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, field_display_value = <em>field_display_value<\/em>]<br \/>\n\t<code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, page_title = <em>message_to_display_to_user<\/em>] <\/code><br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_yes = <em>button_title<\/em>]<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_no = <em>button_title<\/em>]<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_cancel = <em>button_title<\/em>] <\/code><br \/>\n\t<code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, window_height = <em>height<\/em>]<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, window_width = <em>width<\/em>]}<\/code><\/p>\n<p>The <code>ESTOP<\/code>, or Extended Stop action allows the administrator to configure the <code>STOP <\/code>action by providing a configurable message and configurable buttons that appear to the user when the action is triggered.&nbsp; Note that the action rule must be used in conjunction with a &#8220;flag&#8221; field.&nbsp; The reason is that simply introducing a pause into the pre-update process means there is a likelihood that the rule will be executed again when the user clicks the continue button, and the ESTOP rule wlll then trigger again.&nbsp; View the example below on how to use a field, which may be hidden from view to the user, to avoid this problem.<\/p>\n<ul>\n<li>\n\t\tThis action only works within a <code>&lt;== preupdate ==&gt;<\/code> rule directive<\/li>\n<li>\n\t\tThe<code> target_field_name<\/code> must exist on the form and be writable.&nbsp; This parameter is required<\/li>\n<li>\n\t\tThe <code>field_display_value<\/code> parameter is only used with fields that have a POPUP display type (only list and user fields may be configured with POPUP attributes<\/li>\n<li>\n\t\tThe<code> field_value<\/code> must be provided<\/li>\n<li>\n\t\tThe <code>page_title<\/code> parameter is the message that will appear to the user within the popup dialog that is triggered with the action.&nbsp; This message may contain valid HTML<\/li>\n<li>\n\t\tThe <code>button_yes<\/code>, <code>button_no<\/code> and <code>button_cancel<\/code> parameters allow you to display different labels on the Yes, No and Cancel buttons that appear on the popup dialog.&nbsp; These are optional.&nbsp; For example, you might only provide the <code>button_yes<\/code> and <code>button_no<\/code> buttons on the popup dialog<\/li>\n<li>\n\t\tThe <code>window_height<\/code> and <code>window_width<\/code> parameters should be integer numbers, for the height and width of the popup dialog window, expressed in pixels.<\/li>\n<\/ul>\n<h3>\n\tExample<\/h3>\n<p>As a precursor to executing this example rule, the administrator will have placed the PRIORITY field on the layout, and there will be a text field named FLAG_FIELD on the layout.&nbsp; The flag field may be hidden.<\/p>\n<p><code>&lt;== preupdate ==&gt;<\/code><br \/>\n\t<code>if (PRIORITY!='High' &amp;&amp; IS_HIGH_RISK = 'Yes' &amp;&amp; RISK_FLAG_FIELD != 'Y') {<br \/>\n\t&nbsp; &nbsp;{ESTOP: 'PRIORITY',<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; FIELD_VALUE&nbsp;&nbsp; = 'Yes',<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; BUTTON_YES&nbsp;&nbsp;&nbsp; = 'Yes, set the Priority to High',<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; BUTTON_NO&nbsp;&nbsp;&nbsp;&nbsp; = 'No, leave Priority as is',<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; PAGE_TITLE&nbsp;&nbsp;&nbsp; = '&lt;b&gt;This issue has been identified as High Risk, should the Priority be set to High?&lt;\/b&gt;',<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; WINDOW_HEIGHT = 250,<br \/>\n\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; WINDOW_WIDTH&nbsp; = 500<br \/>\n\t&nbsp; };<br \/>\n\t&nbsp; RISK_FLAG_FIELD='Y';<br \/>\n\t}<\/code><\/p>\n<p>\tThis will result in a popup when the rule is triggered.&nbsp; This will have the message &#8220;<b>This issue has been identified as High Risk, should the Priority be set to High?<\/b>&nbsp; There will be two buttons with the labels <b>Yes, set the Priority to High<\/b> and <b>No, leave Priority as is<\/b>. At the same time, the value of RISK_FLAG_FIELD is set to <strong>Y<\/strong>, which prevents the ESTOP rule from firing a second time.<\/p>\n<h3>\n\tTip<\/h3>\n<p>It is not easy to enter more than simple HTML for the <code>PAGE_TITLE<\/code> parameter within the rules editor.&nbsp; You can consider entering the HTML into an HTML Area field, either hidden on the current form or held in a different Business Area \/ Project and accessed with a LINK directive rule.&nbsp; Then you can simply refer to a hidden field within the same Business Area \/ Project like so:<\/p>\n<p><code>PAGE_TITLE = field_name;<\/code><\/p>\n","protected":false},"excerpt":{"rendered":"<p>{ESTOP: target_field_name, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; field_value = field_value &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, field_display_value = field_display_value] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, page_title = message_to_display_to_user] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_yes = button_title] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_no = button_title] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_cancel = button_title] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, window_height = height] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, window_width = width]} The ESTOP, or Extended Stop action allows the administrator to configure the STOP action&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24052,"menu_order":7,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24058","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>ESTOP - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"ESTOP - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"{ESTOP: target_field_name, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; field_value = field_value &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, field_display_value = field_display_value] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, page_title = message_to_display_to_user] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_yes = button_title] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_no = button_title] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_cancel = button_title] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, window_height = height] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, window_width = width]} The ESTOP, or Extended Stop action allows the administrator to configure the STOP action...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-13T21:04:26+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/\",\"name\":\"ESTOP - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-13T21:04:26+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Administration Guide\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Site Configuration Menu\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Business Rules\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Language Description\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"Actions\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/\"},{\"@type\":\"ListItem\",\"position\":8,\"name\":\"ESTOP\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"ESTOP - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/","og_locale":"en_US","og_type":"article","og_title":"ESTOP - Product Documentation","og_description":"{ESTOP: target_field_name, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; field_value = field_value &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, field_display_value = field_display_value] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, page_title = message_to_display_to_user] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_yes = button_title] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_no = button_title] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, button_cancel = button_title] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, window_height = height] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [, window_width = width]} The ESTOP, or Extended Stop action allows the administrator to configure the STOP action...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-13T21:04:26+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/","name":"ESTOP - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-13T21:04:26+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/estop-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Administration Guide","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/"},{"@type":"ListItem","position":4,"name":"Site Configuration Menu","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/"},{"@type":"ListItem","position":5,"name":"Business Rules","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/"},{"@type":"ListItem","position":6,"name":"Language Description","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/"},{"@type":"ListItem","position":7,"name":"Actions","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/business-rules-1\/language-description-1\/actions-1\/"},{"@type":"ListItem","position":8,"name":"ESTOP"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24058","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24058"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24058\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24052"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24058"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}