{"id":22317,"date":"2024-02-15T14:48:40","date_gmt":"2024-02-15T22:48:40","guid":{"rendered":"https:\/\/docs.extraview.com\/v22\/book\/home-page-shortcut-buttons\/"},"modified":"2024-02-15T14:48:40","modified_gmt":"2024-02-15T22:48:40","slug":"home-page-shortcut-buttons","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/","title":{"rendered":"Home Page Shortcut Buttons"},"content":{"rendered":"

This feature allows any number of shortcut buttons to be placed on a layout that is part of the Home Page. The shortcuts either jump to an add<\/em> screen or run a report.<\/p>\n

Permissions to the shortcut buttons are controlled by the permission the user has to the underlying object. For example, if you are using a shortcut button to go to an add<\/em> screen, then the user must have permission to go to the business area and project of the add<\/em> screen. If you are using the shortcut button to run a report, then it is the permission the user has to that report that controls the visibility of the button.<\/p>\n

\n\tCreating the Button Fields<\/h3>\n

Create a field in the data dictionary for each shortcut button that you require. To create a shortcut to an add<\/em> screen, create a field where the fixed name has the form BUTTON_ADD_name<\/b>. To create a shortcut to a report, the fixed name must have the form BUTTON_RUN_name<\/b>. All fields should have a display type of Custom<\/b>. The title of the button becomes the text that appears on the button. Make sure you provide security permissions for each role that you want to use each button. This is an example of a button in the data dictionary:<\/p>\n

<\/p>\n

Shortcut Button in the Data Dictionary<\/span><\/p>\n

\n\tCreating the Layout Type<\/h3>\n

Go to Administration Fields & Layouts Create and Maintain Layout Types<\/b>. Add a new layout type. This layout type must have a fixed name of HOME_PAGE<\/b>. The usage must be Screen<\/b>.<\/p>\n

\n\tAdding the Layout to the Home Page<\/h3>\n

Go to Administration Fields & Layouts Design Center<\/b>. You may create a Home Page layout in the * Global Area<\/b> * where it will be used across all business areas and projects, or using the standard inheritance mechanism, you can create different Home Page shortcut layouts in different business areas, projects or roles. Use the Add a new layout for the entire system<\/b> select list to add the layout type you just created in the previous step.<\/p>\n

After adding the layout, you are able to place the buttons onto the layout, similar to the screen shown here:<\/p>\n

<\/p>\n

HOME_PAGE Layout<\/span><\/p>\n

This screenshot creates a single row of shortcut buttons. You may create multiple rows of buttons. You must next add layout cell attributes to each button. These describe the action for the button as follows.<\/p>\n

\n\tShortcut Add Buttons<\/h3>\n\n\n\n\n\n\n\n
\n\t\t\t\tAttribute<\/td>\n\n\t\t\t\tExample<\/td>\n\n\t\t\t\tPurpose<\/td>\n<\/tr>\n
\n\t\t\t\tFIELD HTML MODIFIER<\/td>\n\n\t\t\t\tAREA:BUGS<\/td>\n\n\t\t\t\tThis points the button to add an issue in the BUG<\/b> business area. The name of the business area provided must match the name of an existing business area to which the user has permission. To see the names of the business areas in your installation, go to Administration Lists Business Areas<\/b>. This modifier is required.<\/td>\n<\/tr>\n
\n\t\t\t\tFIELD HTML MODIFIER<\/td>\n\n\t\t\t\tPROJECT:BUGS_DATA<\/td>\n\n\t\t\t\tThis points the button to add an issue in the BUGS_DATA<\/b> project within the business area specified by the AREA<\/em>: modifier above. This is required. Note that the Project fixed name must match the one into which you want to add data. Normally, this is not<\/b> the Project with an ID of 0. If you are not certain of the Business Area and Project names, go to Administration Lists Project<\/b>, select the Business Area and you will see a list of all the Projects within the Business Area.<\/td>\n<\/tr>\n
\n\t\t\t\tFIELD STYLE<\/td>\n\n\t\t\t\tHomePageAddBug.gif<\/td>\n\n\t\t\t\tThis is an optional attribute. If it is provided, the button will use this image for the button. The image is situated within the directory pointed to by the behavior setting named IMG_NAV_BAR_HOME. If you do not provide a STYLE attribute, then the button is rendered as a text style HTML button. Images for Home Page Shortcuts are not provided, but can easily be created with any button\/image creation program.<\/p>\n

If ExtraView Corporation is hosting your installation, you do not have direct access to the file system of the server upload these images to the web server.<\/p>\n<\/td>\n<\/tr>\n

\n\t\t\t\tFIELD HTML MODIFIER<\/td>\n\n\t\t\t\tCSS:font-size:20pt;background-color:#FF8888<\/td>\n\n\t\t\t\tThis is an optional attribute that overrides the built-in style of buttons, allowing you to set your own style. The style is expressed as CSS. Do not use this if you are using the STYLE<\/b> attribute<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example of the attributes for an add shortcut button.<\/p>\n

<\/p>\n

Shortcut Button Attributes<\/span><\/p>\n

\n\tShortcut Run Buttons<\/h2>\n\n\n\n\n\n\n
\n\t\t\t\tAttribute<\/td>\n\n\t\t\t\tExample<\/td>\n\n\t\t\t\tPurpose<\/td>\n<\/tr>\n
\n\t\t\t\tFIELD HTML MODIFIER<\/td>\n\n\t\t\t\tREPORT:My Report<\/td>\n\n\t\t\t\tThis points the button to run the report named My Report<\/b>. The name must match the title of an existing report which the user has permission to run. This is required. Note that running Container reports and Custom URL reports from shortcut buttons is not supported.<\/td>\n<\/tr>\n
\n\t\t\t\tFIELD STYLE<\/td>\n\n\t\t\t\tHomPageAddBug.gif<\/td>\n\n\t\t\t\tThis is an optional attribute. If it is provided, the button will use this image for the button. The image is situated within the directory pointed to by the behavior setting named IMG_NAV_BAR_HOME. If you do not provide a STYLE attribute, then the button is rendered as a text style HTML button. Images for Home Page Shortcuts are not provided, but can easily be created with any button\/image creation program.<\/p>\n

If ExtraView Corporation is hosting your installation, you do not have direct access to the file system of the server to upload these images to the web server.<\/p>\n<\/td>\n<\/tr>\n

\n\t\t\t\tFIELD HTML MODIFIER<\/td>\n\n\t\t\t\tCSS:font-size:20pt;background-color:#FF8888<\/td>\n\n\t\t\t\tThis is an optional attribute that overrides the built-in style of buttons, allowing you to set your own style. The style is expressed as CSS. Do not use this if you are using the STYLE<\/b> attribute<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example of the attributes for a run report shortcut button.<\/p>\n

<\/p>\n

Shortcut Button Attributes<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

This feature allows any number of shortcut buttons to be placed on a layout that is part of the Home Page. The shortcuts either jump to an add screen or run a report. Permissions to the shortcut buttons are controlled by the permission the user has to the underlying object. For example, if you are…<\/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-22317","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nHome Page Shortcut Buttons - 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\/home-page-shortcut-buttons\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Home Page Shortcut Buttons - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This feature allows any number of shortcut buttons to be placed on a layout that is part of the Home Page. The shortcuts either jump to an add screen or run a report. Permissions to the shortcut buttons are controlled by the permission the user has to the underlying object. For example, if you are...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/\" \/>\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=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/\",\"url\":\"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/\",\"name\":\"Home Page Shortcut Buttons - 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\/home-page-shortcut-buttons\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v22\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Home Page Shortcut Buttons\"}]},{\"@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":"Home Page Shortcut Buttons - 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\/home-page-shortcut-buttons\/","og_locale":"en_US","og_type":"article","og_title":"Home Page Shortcut Buttons - Product Documentation","og_description":"This feature allows any number of shortcut buttons to be placed on a layout that is part of the Home Page. The shortcuts either jump to an add screen or run a report. Permissions to the shortcut buttons are controlled by the permission the user has to the underlying object. For example, if you are...","og_url":"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/","og_site_name":"Product Documentation","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/","url":"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/","name":"Home Page Shortcut Buttons - 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\/home-page-shortcut-buttons\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v22\/home-page-shortcut-buttons\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v22\/"},{"@type":"ListItem","position":2,"name":"Home Page Shortcut Buttons"}]},{"@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\/22317","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=22317"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages\/22317\/revisions"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/media?parent=22317"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}