{"id":22188,"date":"2024-02-15T14:48:40","date_gmt":"2024-02-15T22:48:40","guid":{"rendered":"https:\/\/docs.extraview.com\/v22\/book\/button-fields\/"},"modified":"2024-02-15T14:48:40","modified_gmt":"2024-02-15T22:48:40","slug":"button-fields","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v22\/button-fields\/","title":{"rendered":"Button Fields"},"content":{"rendered":"

\n\tInbuilt Button Fields<\/h3>\n\n\n\n\n\n\n\n\n\n
\n\t\t\t\tField Name<\/td>\n\n\t\t\t\tTitle<\/td>\n\n\t\t\t\tDefinition<\/td>\n<\/tr>\n
\n\t\t\t\tDELETE_BUTTON<\/td>\n\n\t\t\t\tDelete Button<\/td>\n\n\t\t\t\tThe item delete button. Access to the security permissions for this button allow users to delete issues<\/td>\n<\/tr>\n
\n\t\t\t\tEDIT_BUTTON<\/td>\n\n\t\t\t\tEdit Button<\/td>\n\n\t\t\t\tThe drill down edit button used on reports and within email<\/td>\n<\/tr>\n
\n\t\t\t\tHISTORY_BUTTON<\/td>\n\n\t\t\t\tHistory Button<\/td>\n\n\t\t\t\tThe button that accesses history from the edit screen or reports<\/td>\n<\/tr>\n
\n\t\t\t\tQUICKEDIT_BUTTON<\/td>\n\n\t\t\t\tQuickedit Button<\/td>\n\n\t\t\t\tThe button that accesses the Quickedit mode from column reports and Quicklists<\/td>\n<\/tr>\n
\n\t\t\t\tVIEW_BUTTON<\/td>\n\n\t\t\t\tView Button<\/td>\n\n\t\t\t\tThe drill down button that allows you to see the detailed report for an issue<\/td>\n<\/tr>\n
\n\t\t\t\tSAVE_BUTTON<\/td>\n\n\t\t\t\tSave Button<\/td>\n\n\t\t\t\tThis button is used on attachment layouts, allowing users to save rather than view attachments<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n\tUser Defined Button Fields<\/h3>\n

The preferred method of creating button fields is to use the LABELS \/ BUTTONS tab within the data dictionary and create the button field there.  Historically, before version 20.0, button fields were created as UDF fields with a specially formatted name and with a Custom display type.  The Help Text was used to create the label text for the button.  Whilst the old method is maintained for backwards compatibility it is now recommended that you create a native type button field.<\/p>\n

The historic method allows you to create and place a button with any label of your choosing on an add<\/em> or edit<\/em> screen by defining a field with a display type of Custom in the data dictionary, with its name beginning with the characters BUTTON_<\/b> or ending with the characters _BTN<\/b>. Placing this field on an add<\/em> or edit<\/em> screen layout results in a button being generated on the screen, when you place the field on a layout.  Note that when you create a button field in this manner, a global attribute named CONFIRM_STANDARDS is added to it’s data dictionary entry.  This does not need to be altered in any way by the administrator.<\/p>\n

The following are used to define these historic buttons:<\/p>\n\n\n\n\n\n\n\n
\n\t\t\t\tData dictionary field<\/td>\n\n\t\t\t\tPurpose<\/td>\n<\/tr>\n
\n\t\t\t\tName<\/td>\n\n\t\t\t\tThis defines the name of the field. For example, a button named BUTTON_GENERATE is valid.<\/td>\n<\/tr>\n
\n\t\t\t\tDisplay Type<\/td>\n\n\t\t\t\tMust be Custom<\/b><\/td>\n<\/tr>\n
\n\t\t\t\tTitle<\/td>\n\n\t\t\t\tTypically this is a space character<\/td>\n<\/tr>\n
\n\t\t\t\tHelp Text<\/td>\n\n\t\t\t\tThis will become the text on the button<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

To provide the action for the button, place a layout cell attribute of type FIELD HTML MODIFIER within the layout upon which you place the button. There are three primary ways you can provide an action for this button:<\/p>\n

    \n
  • \n\t\tIf you want to open a new window where you can add a different issue, your FIELD HTML MODIFIER may look like this:<\/p>\n

    \t\tonclick=window.open(“evSignon?p_action=doAddDisplay&p_option=Display&p_close_win=true&ev_menu=off&p_area=7&p_project=9”)<\/span><\/p>\n

    \t\tThe parameters for the Area and Project use their respective IDs. Note that the URL does not need to reside within ExtraView and your action might open up a web address anywhere. See the API Guide for more information.<\/li>\n

  • \n\t\tYour button might look to execute business rules. As an example, you might want to add a new issue directly into the database, using values from the current issue. When pressing your button executes an onchange <\/code>business rule, ExtraView will execute the necessary onclick <\/code>action to initiate the action. <\/p>\n

    \t\tIn versions of ExtraView prior to 10.0, you may have added a JavaScript function via the HTML_MODIFIER attribute, such as:  <\/p>\n

    \t\tonclick='javascript:;userSubmitChangeAjax(this.name)'; <\/code><\/p>\n

    \t\tThis is no longer required for the functionality to work. If you have such a HTML_MODIFIER, it will adversely effect the smooth functioning of the ExtraView code by introducing unnecessary screen refreshes.  Therefore, remove the HTML_MODIFIER if it exists from a previous version<\/li>\n

  • \n\t\tCreate your business rules. This example shows how you might add an issue into a different business area, while copying over some of the field values from the current issue. It is based upon your button field name being BUTTON_CREATE_TEST_CASE:<\/p>\n

    \t\tif (BUTTON_CREATE_TEST_CASE.{changed}) {
    \n\t\t  ADD :
    \n\t\t    AREA = 'Test Case Management';
    \n\t\t    TEST_CASE_STATUS = 'New';
    \n\t\t    PROCEDURE = TEST_INSTRUCTIONS;
    \n\t\t    MODULE_ID = MODULE_ID;
    \n\t\t    ASSIGNED_TO = '{null}';
    \n\t\t    CREATED_FROM_BUG_ID = ID;
    \n\t\t    COMMENTS = DESCRIPTION;
    \n\t\t}<\/code><\/li>\n

  • \n\t\tYou can provide an action for the button by implementing custom code within the method named ucRenderEmbeddedObject<\/span>. The standard distribution of ExtraView that ships with the user custom class named CustomCodeBase.java contains this functionality. In this case, you would write a user custom JavaScript function that submits a URL to the server to execute the server-side code within CustomCodeBase.java.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"

    Inbuilt Button Fields Field Name Title Definition DELETE_BUTTON Delete Button The item delete button. Access to the security permissions for this button allow users to delete issues EDIT_BUTTON Edit Button The drill down edit button used on reports and within email HISTORY_BUTTON History Button The button that accesses history from the edit screen or reports…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"","_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-22188","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nButton Fields - 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\/v22\/button-fields\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Button Fields - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"Inbuilt Button Fields Field Name Title Definition DELETE_BUTTON Delete Button The item delete button. Access to the security permissions for this button allow users to delete issues EDIT_BUTTON Edit Button The drill down edit button used on reports and within email HISTORY_BUTTON History Button The button that accesses history from the edit screen or reports...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v22\/button-fields\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\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\/v22\/button-fields\/\",\"url\":\"https:\/\/docs.extraview.com\/v22\/button-fields\/\",\"name\":\"Button Fields - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#website\"},\"datePublished\":\"2024-02-15T22:48:40+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/button-fields\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v22\/button-fields\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/button-fields\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v22\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Button Fields\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v22\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v22\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v22\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#\/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\/v22\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Button Fields - 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\/v22\/button-fields\/","og_locale":"en_US","og_type":"article","og_title":"Button Fields - Product Documentation","og_description":"Inbuilt Button Fields Field Name Title Definition DELETE_BUTTON Delete Button The item delete button. Access to the security permissions for this button allow users to delete issues EDIT_BUTTON Edit Button The drill down edit button used on reports and within email HISTORY_BUTTON History Button The button that accesses history from the edit screen or reports...","og_url":"https:\/\/docs.extraview.com\/v22\/button-fields\/","og_site_name":"Product Documentation","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\/v22\/button-fields\/","url":"https:\/\/docs.extraview.com\/v22\/button-fields\/","name":"Button Fields - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v22\/#website"},"datePublished":"2024-02-15T22:48:40+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v22\/button-fields\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v22\/button-fields\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v22\/button-fields\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v22\/"},{"@type":"ListItem","position":2,"name":"Button Fields"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v22\/#website","url":"https:\/\/docs.extraview.com\/v22\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v22\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v22\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v22\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v22\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v22\/#\/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\/v22\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v22\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages\/22188","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/comments?post=22188"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages\/22188\/revisions"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/media?parent=22188"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}