{"id":5193,"date":"2024-03-19T16:49:04","date_gmt":"2024-03-19T15:49:04","guid":{"rendered":"https:\/\/help.r2docuo.com\/knowledge-base\/create-buttons-in-the-details-window\/"},"modified":"2024-07-01T18:12:34","modified_gmt":"2024-07-01T16:12:34","slug":"create-buttons-in-the-details-window","status":"publish","type":"ht_kb","link":"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/","title":{"rendered":"Create Buttons in the details window"},"content":{"rendered":"\n

This article explains how to create buttons in the details window of a category to execute actions when a user clicks on them. For example the “Analyze contract” button in this image:<\/p>\n\n

\"\"<\/figure>\n\n

Create a new button<\/h2>\n\n

The buttons are created as if they were a data field. Simply create a new field and choose the “Button” type in the “Data fields” step of the R2 Docuo Category Wizard:<\/p>\n\n

\"\"<\/figure>\n\n

IMPORTANT<\/strong>: It is not possible to create a button in a shared field group, nor to share a field group containing a button.<\/p>\n\n

Choose the icon and appearance of the button<\/h2>\n\n

You can configure the button icon in the “Appearance” section of the field options:<\/p>\n\n

\"\"<\/figure>\n\n

Configure the actions that are executed when a user presses the button.<\/h2>\n\n

When a user clicks on a button in the details window, you can schedule what happens in three separate and consecutive events:<\/p>\n\n

\"\"<\/figure>\n\n

First event: “Script”.<\/h3>\n\n

This is a script (Javascript) that is executed first, immediately after the user clicks the button. This script can be configured in the “Events” section of the button options:<\/p>\n\n

\"\"<\/figure>\n\n

The advantage of programming the button behavior in the“On button press<\/em>” event instead of in the“Action<\/em>” Event (see below) is that, if the JavaScript functions used do not require using the R2 Docuo server (e.g. calculating the sum of two fields and placing the result in a third one or checking a condition), the execution is immediate and without waiting<\/strong>, since it is performed on the user’s device.<\/p>\n\n

If the script does not return anything, everything will be considered OK. If the script returns a text string, it will be interpreted that an error has occurred and that text string will be displayed to the user.<\/p>\n\n

Second event: “Advancing by”.<\/h3>\n\n

Allows to configure a change of state when the user presses the button.<\/p>\n\n

\"\"<\/figure>\n\n

Third event: “Action”.<\/h3>\n\n

Allows you to execute one or several R2 Docuo automatic actions from among all those available: sending an e-mail, creating a document template, executing a script, etc. The action is configured in the “Events” section of the button options:<\/p>\n\n

\"\"<\/figure>\n\n

When configuring the Action event, all available actions are displayed:<\/p>\n\n

\"\"<\/figure>\n\n

If we click on the “New” button, we can add Actions of various types:<\/p>\n\n

\"\"<\/figure>\n\n

Set up a confirmation message<\/h2>\n\n

The “Confirmation message” property allows configuring a message, which will be displayed to the user when the actions programmed in the button events are completed without errors:<\/p>\n\n

\"\"<\/figure>\n\n

Error messages<\/h2>\n\n

Error messages may be displayed at two points: <\/p>\n\n

    \n
  1. If the execution of the “On button press” event returns a text string, this will be understood as an error and will be displayed to the user.<\/li>\n\n\n\n
  2. If the execution of the “Action” event returns an R2 Docuo error, it will be displayed to the user.<\/li>\n<\/ol>\n\n

    If there are no errors, the confirmation message is displayed.<\/p>\n\n

    If the execution of the“On button press<\/em>” event returns an error (a text string), the subsequent “Action” event will not be executed.<\/p>\n\n

    Execute group button actions<\/h2>\n\n

    If the “Allow in group” option of a button is set to “Yes”, it is possible to select several documents of this category in any list of results, right-click on them and perform the action for all of them:<\/p>\n\n

    The execution in this case will be carried out sequentially, document after document.<\/p>\n\n

    User experience at the push of a button<\/h2>\n\n

    When a user presses a button, if the “Action” event is configured, or if the “On button press” Event uses R2 Docuo server-side functions, the user will see the document go to the “Automating” state for the duration of the actions execution. <\/p>\n\n

    In this state, all fields will remain read-only and a progress bar will be displayed (as, for example, when changing status).<\/p>\n\n

    When the automation is finished, the confirmation message is displayed to the user and the fields return to their usual state.<\/p>\n","protected":false},"excerpt":{"rendered":"

    This article explains how to create buttons in the details window of a category to execute actions when a user clicks on them. For example the “Analyze contract” button in this image: Create a new button The buttons are created as if they were a data field. Simply create a…<\/p>\n","protected":false},"author":1,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"content-type":"","footnotes":""},"ht-kb-category":[63,65],"ht-kb-tag":[83],"class_list":["post-5193","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-fields","ht_kb_category-automation","ht_kb_tag-docuo-enterprise"],"yoast_head":"\nCreate Buttons in the details window - R2 Docuo | Help center<\/title>\n<meta name=\"robots\" content=\"noindex, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Create Buttons in the details window - R2 Docuo | Help center\" \/>\n<meta property=\"og:description\" content=\"This article explains how to create buttons in the details window of a category to execute actions when a user clicks on them. For example the “Analyze contract” button in this image: Create a new button The buttons are created as if they were a data field. Simply create a...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/\" \/>\n<meta property=\"og:site_name\" content=\"R2 Docuo | Help center\" \/>\n<meta property=\"article:modified_time\" content=\"2024-07-01T16:12:34+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2024\/03\/image-9.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@R2Docuo\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/\",\"url\":\"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/\",\"name\":\"Create Buttons in the details window - R2 Docuo | Help center\",\"isPartOf\":{\"@id\":\"https:\/\/help.r2docuo.com\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2024\/03\/image-9.png\",\"datePublished\":\"2024-03-19T15:49:04+00:00\",\"dateModified\":\"2024-07-01T16:12:34+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#primaryimage\",\"url\":\"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2024\/03\/image-9.png\",\"contentUrl\":\"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2024\/03\/image-9.png\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Portada\",\"item\":\"https:\/\/help.r2docuo.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Buttons in the details window\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/help.r2docuo.com\/#website\",\"url\":\"https:\/\/help.r2docuo.com\/\",\"name\":\"R2 Docuo | Help center\",\"description\":\"Todos los recursos para usuarios, administradores y desarrolladores de de R2 Docuo a tu alcance\",\"publisher\":{\"@id\":\"https:\/\/help.r2docuo.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/help.r2docuo.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/help.r2docuo.com\/#organization\",\"name\":\"R2 Docuo | Help center\",\"url\":\"https:\/\/help.r2docuo.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/help.r2docuo.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2023\/06\/ILUDEST_CENTRODEAYUDA.png\",\"contentUrl\":\"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2023\/06\/ILUDEST_CENTRODEAYUDA.png\",\"width\":1200,\"height\":630,\"caption\":\"R2 Docuo | Help center\"},\"image\":{\"@id\":\"https:\/\/help.r2docuo.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/x.com\/R2Docuo\",\"https:\/\/www.linkedin.com\/company\/r2docuo\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Create Buttons in the details window - R2 Docuo | Help center","robots":{"index":"noindex","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"og_locale":"en_US","og_type":"article","og_title":"Create Buttons in the details window - R2 Docuo | Help center","og_description":"This article explains how to create buttons in the details window of a category to execute actions when a user clicks on them. For example the “Analyze contract” button in this image: Create a new button The buttons are created as if they were a data field. Simply create a...","og_url":"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/","og_site_name":"R2 Docuo | Help center","article_modified_time":"2024-07-01T16:12:34+00:00","og_image":[{"url":"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2024\/03\/image-9.png","type":"","width":"","height":""}],"twitter_card":"summary_large_image","twitter_site":"@R2Docuo","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/","url":"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/","name":"Create Buttons in the details window - R2 Docuo | Help center","isPartOf":{"@id":"https:\/\/help.r2docuo.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#primaryimage"},"image":{"@id":"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#primaryimage"},"thumbnailUrl":"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2024\/03\/image-9.png","datePublished":"2024-03-19T15:49:04+00:00","dateModified":"2024-07-01T16:12:34+00:00","breadcrumb":{"@id":"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#primaryimage","url":"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2024\/03\/image-9.png","contentUrl":"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2024\/03\/image-9.png"},{"@type":"BreadcrumbList","@id":"https:\/\/help.r2docuo.com\/en\/knowledge-base\/create-buttons-in-the-details-window\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Portada","item":"https:\/\/help.r2docuo.com\/"},{"@type":"ListItem","position":2,"name":"Create Buttons in the details window"}]},{"@type":"WebSite","@id":"https:\/\/help.r2docuo.com\/#website","url":"https:\/\/help.r2docuo.com\/","name":"R2 Docuo | Help center","description":"Todos los recursos para usuarios, administradores y desarrolladores de de R2 Docuo a tu alcance","publisher":{"@id":"https:\/\/help.r2docuo.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/help.r2docuo.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/help.r2docuo.com\/#organization","name":"R2 Docuo | Help center","url":"https:\/\/help.r2docuo.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/help.r2docuo.com\/#\/schema\/logo\/image\/","url":"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2023\/06\/ILUDEST_CENTRODEAYUDA.png","contentUrl":"https:\/\/help.r2docuo.com\/wp-content\/uploads\/2023\/06\/ILUDEST_CENTRODEAYUDA.png","width":1200,"height":630,"caption":"R2 Docuo | Help center"},"image":{"@id":"https:\/\/help.r2docuo.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/x.com\/R2Docuo","https:\/\/www.linkedin.com\/company\/r2docuo"]}]}},"_links":{"self":[{"href":"https:\/\/help.r2docuo.com\/en\/wp-json\/wp\/v2\/ht-kb\/5193","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.r2docuo.com\/en\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/help.r2docuo.com\/en\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/help.r2docuo.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/help.r2docuo.com\/en\/wp-json\/wp\/v2\/comments?post=5193"}],"version-history":[{"count":0,"href":"https:\/\/help.r2docuo.com\/en\/wp-json\/wp\/v2\/ht-kb\/5193\/revisions"}],"wp:attachment":[{"href":"https:\/\/help.r2docuo.com\/en\/wp-json\/wp\/v2\/media?parent=5193"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/help.r2docuo.com\/en\/wp-json\/wp\/v2\/ht-kb-category?post=5193"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/help.r2docuo.com\/en\/wp-json\/wp\/v2\/ht-kb-tag?post=5193"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}