{"id":24605,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/ucsearchplanningreport-1\/"},"modified":"2024-02-15T14:53:34","modified_gmt":"2024-02-15T22:53:34","slug":"ucsearchplanningreport-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/","title":{"rendered":"ucSearchPlanningReport"},"content":{"rendered":"<h3>\n\tPurpose<\/h3>\n<h3>\n\tApplies To<\/h3>\n<p>Custom Planning Style Reports.&nbsp; Custom planning style reports are typically embedded within an <em>add <\/em>or <em>edit <\/em>screen.&nbsp; This user custom exit allows these reports to be run outside of these screens.&nbsp; The base code triggers the request to run the report from an internal flag and this cannot be accessed outside the <em>add<\/em> and <em>edit<\/em> pages.&nbsp; A UDF field is used to pass this information and to act as a filter.<\/p>\n<h3>\n\tSignature<\/h3>\n<pre class=\"code\">\r\n<code>public boolean ucSearchPlanningReport( \r\n                  HttpServletRequest request, \r\n                  HttpServletResponse response, \r\n                  Connection dbconn, \r\n                  SesameSession session) \r\n                       throws Exception <\/code>\r\n<\/pre>\n<h3>\n\tNotes<\/h3>\n<h3>\n\tExample<\/h3>\n<ul>\n<li>\n\t\tCreate a user defined field to be used as the flag.<\/p>\n<ul>\n<li>\n\t\t\t\tFor example, create a field in the data dictionary as follows:<\/p>\n<p>\t\t\t\tFixed Name = UC_PLAN_RUN<br \/>\n\t\t\t\tTitle to display = Execute UC Plan Report<br \/>\n\t\t\t\tDisplay Type = Text Field<br \/>\n\t\t\t\tFilter Criteria = Yes<\/li>\n<\/ul>\n<\/li>\n<li>\n\t\tModify or create&nbsp;a Planning Report<\/p>\n<ul>\n<li>\n\t\t\t\tAdd the following filter:<\/p>\n<p>\t\t\t\t&#8220;Execute UC Plan Report&#8221; (UC_PLAN_RUN) = Y<br \/>\n\t\t\t\t&nbsp;<\/li>\n<li>\n\t\t\t\tSave the Report.<br \/>\n\t\t\t\t&nbsp;<\/li>\n<\/ul>\n<\/li>\n<li>\n\t\tModify the user custom exit <code>ucSearchPlanningReport <\/code>as follows:<\/p>\n<pre>\r\n\r\n\r\n<code>Report report = (Report)session.getAttribute(PlanningController.SES_PLAN_MASTER_REPORT);\r\nString title = report.getTitle();\r\nString relGroupId = report.getHierarchyId();\r\nif (\"2\".equals(relGroupId)) { \r\n  FilterGroup filterGroup = report.getFilterGroup(); \r\n  Filter f = filterGroup.getFilter(\"UC_PLAN_RUN\");\r\n \r\n  \/\/ do not run unless the runUC flag has been set. \r\n  if(f==null || (f!=null &amp;&amp; !\"Y\".equals(f.getFilterCriteria().get(0)))) return; \r\n\r\n  \/\/ check to see if the \r\n  f = filterGroup.getFilter(\"REPORT_START_DATE\"); \r\n  if(f==null) return; \r\n  String reportStartDate= (String)f.getFilterCriteria().get(0); \r\n  f = filterGroup.getFilter(\"REPORT_END_DATE\"); \r\n  if(f==null) return; \r\n  String reportEndDate = (String)f.getFilterCriteria().get(0); \r\n\r\n  \/\/ set start date in session so that the report begins 7 days before the delivery date. \r\n  try { \r\n    if (TextManager.isStringVisible(reportStartDate)) {\r\n    Calendar dateCal = Convert.getCalendarDayFromString(session, reportStartDate);\r\n    dateCal.add(Calendar.DATE,-7);\r\n    Date startDt = dateCal.getTime(); \r\n    session.setAttribute(PlanningController.SES_START_DT, startDt);\r\n  }\r\n} catch (Exception subE) {\r\n  Z.logtrace(subE, Log.ERROR); \r\n} \r\n\/\/ exit if the report start and end dates are not set. \r\nif(   TextManager.isStringInvisible(reportStartDate) \r\n   || TextManager.isStringInvisible(reportEndDate)) return; \r\n\/\/ remove these fields from the report because we do not want them used \r\n\/\/ to filter the results. \r\nfilterGroup.removeFilter(\"REPORT_START_DATE\"); \r\nfilterGroup.removeFilter(\"REPORT_END_DATE\"); \r\nfilterGroup.removeFilter(\"UC_PLAN_RUN\"); \r\n\r\n\/\/ set the sort order based on Product Name. \r\nSortOrder so = new SortOrder(); \r\nSortOrderField sof = new SortOrderField(); \r\nsof.setConnection(dbconn); \r\nsof.setDDName(\"PRODUCT_NAME_UDF\"); \r\nsof.setOrderRank(0); \r\nsof.setSortDirection(\"ASC\"); \r\nso.addField(sof); \r\nreport.addSortOrder(so); \r\n\r\n\/\/ the Report Start Date and the Report End Date are required by UserJavaScript. \r\n\/\/ Place these values in session, so that they are placed on the planning report. \r\nString ucParams = \"={p_from_date_delivery : \\\"\"+deliveryDate+\"\\\",\r\n                  p_to_date_pickup : \\\"\"+collectionDate+\"\\\"};\"; \r\nsession.setAttribute(\"UC_RUN_PLANNING_CUSTOM\",ucParams); \r\n} <\/code><\/pre>\n<\/li>\n<li>\n<pre>\r\nExecute custom JavaScript based on the contents of the ucParams above.\r\n\r\n<code>\/** * ucPlanningReportPostLoad *\/ \r\nfunction ucPlanningReportPostLoad(colMove, pageMove) {\r\n  var runUC = false; \r\n  runUC = (typeof(ucParams) != 'undefined' \r\n             &amp;&amp; typeof(ucParams.p_from_date_delivery) != 'undefined');\r\n  try {\r\n    if ( runUC) { \r\n      \/\/ do stuff \r\n      alert(\" Calling from ucPlanningReportPost Load\"); \r\n      \/\/ changing background colors based on a custom ajax call \r\n    } catch (err) {\r\n      \/\/ ignore the error for now... \r\n      alert('ucPlanningReportPostLoad:'+ err); \r\n    }<\/code><\/pre>\n<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Purpose Applies To Custom Planning Style Reports.&nbsp; Custom planning style reports are typically embedded within an add or edit screen.&nbsp; This user custom exit allows these reports to be run outside of these screens.&nbsp; The base code triggers the request to run the report from an internal flag and this cannot be accessed outside the&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24510,"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-24605","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>ucSearchPlanningReport - 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\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"ucSearchPlanningReport - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"Purpose Applies To Custom Planning Style Reports.&nbsp; Custom planning style reports are typically embedded within an add or edit screen.&nbsp; This user custom exit allows these reports to be run outside of these screens.&nbsp; The base code triggers the request to run the report from an internal flag and this cannot be accessed outside the...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/\" \/>\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=\"3 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\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/\",\"name\":\"ucSearchPlanningReport - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-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\":\"User Custom Guide\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Java Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"User Custom Methods\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"ucSearchPlanningReport\"}]},{\"@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":"ucSearchPlanningReport - 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\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/","og_locale":"en_US","og_type":"article","og_title":"ucSearchPlanningReport - Product Documentation","og_description":"Purpose Applies To Custom Planning Style Reports.&nbsp; Custom planning style reports are typically embedded within an add or edit screen.&nbsp; This user custom exit allows these reports to be run outside of these screens.&nbsp; The base code triggers the request to run the report from an internal flag and this cannot be accessed outside the...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/","og_site_name":"Product Documentation","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/","name":"ucSearchPlanningReport - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucsearchplanningreport-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":"User Custom Guide","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/"},{"@type":"ListItem","position":4,"name":"Java Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/"},{"@type":"ListItem","position":5,"name":"User Custom Methods","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/"},{"@type":"ListItem","position":6,"name":"ucSearchPlanningReport"}]},{"@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\/24605","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=24605"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24605\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24510"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24605"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}