{"id":24533,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/ucclicustom-1\/"},"modified":"2024-02-15T14:53:34","modified_gmt":"2024-02-15T22:53:34","slug":"ucclicustom-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucclicustom-1\/","title":{"rendered":"ucCliCustom"},"content":{"rendered":"<h3>\n\tPurpose<\/h3>\n<p>Exit to control customizing calls by way of the Application Programming Interface, or the Command Line Interface.<\/p>\n<h3>\n\tApplies To<\/h3>\n<p>CLI Methods<\/p>\n<h3>\n\tSignature<\/h3>\n<pre class=\"code\">\r\n<code>public void ucCliCustom (\r\n      HashMap parms, \r\n      PrintWriter out, \r\n      String delim,\r\n      Connection dbconn, \r\n      SesameSession session)<\/code>\r\n<\/pre>\n<h3>\n\tNotes<\/h3>\n<p>This method is called from the CLI when a statevar of custom is passed. Results are written to the PrintWriter and returned to the CLI as output. These can be plain text, HTML, XML, or other formats.<\/p>\n<h3>\n\tExample<\/h3>\n<pre class=\"code\">\r\n<code>public void ucCliCustom (HashMap params,\r\n                         PrintWriter out,\r\n                         String delim,\r\n                         Connection dbconn,\r\n                         SesameSession session)\r\n{\r\n    String op = (String) params.get(\"OPERATION\");\r\n    \r\n    if (\"credit_card_transaction\".equalsIgnoreCase(op) )\r\n    {\r\n        \/\/ doCreditCardTransaction(params, out, dbconn, session);\r\n        \r\n        String issueId = (String) params.get(\"ID\");\r\n        String result = (String) params.get(\"RESULT\");\r\n    \r\n        if (issueId == null || result == null) {\r\n            out.println(\"ERROR: Missing one or more required parameters: ID, RESULT!\");\r\n            return;\r\n        }\r\n        \r\n        \/\/ verify result values and map to CREDIT_CARD_RESULT field\r\n        String creditCardResult = null;\r\n        \r\n        if (result.equals(\"yes\") ) {\r\n            creditCardResult = \"4515\";\r\n            \/\/ These static vars (holding UDF_LIST_ID values)\r\n            \/\/ should be setup in the class constructor\r\n            \/\/ creditCardResult = CREDIT_CARD_RESULT__SUCCESS;\r\n        } else if (result.equals(\"no\") ) {\r\n            creditCardResult = \"4520\";\r\n            \/\/ These static vars (holding UDF_LIST_ID values)\r\n            \/\/ should be setup in the class constructor\r\n            \/\/ creditCardResult = CREDIT_CARD_RESULT__FAIL;\r\n        } else {\r\n            out.println(\"ERROR: RESULT parameter specifies invalid value: \" + result);\r\n        }\r\n        \r\n        if (creditCardResult != null)\r\n        {\r\n            boolean updated = false;\r\n            \r\n            try\r\n            {\r\n                \/\/ verify that id exists\r\n                if (! Problem.isProblemPermitted(dbconn, issueId, false) ) {\r\n                    \/\/ false == readOnly flag\r\n                    out.println(\"ERROR: Record \" + issueId +\r\n                                      \" does not exist or is not accessible!\");\r\n                }\r\n                else\r\n                {\r\n                    \/\/ update payment record with credit card result\r\n                    HashMap updateMap = new HashMap();\r\n                    updateMap.put(\"CREDIT_CARD_RESULT\", creditCardResult);\r\n    \r\n                    if (apiEditItem(issueId, updateMap, dbconn, session) == 0) {\r\n                        out.println(\"ERROR: Failed to update record \" + issueId +\r\n                                          \"!  See logs for details.\");\r\n                    } else {\r\n                        updated = true;\r\n                    }\r\n                }\r\n            } catch (Exception e) {\r\n                ErrorWriter.write(e, ErrorWriter.LOGERR);\r\n                out.println(\"ERROR: General error condition: \" + e.getMessage() );\r\n            }\r\n            \r\n            \/\/ write success response\r\n            if (updated == true) { out.println(\"Record \" + issueId + \" updated.\"); }\r\n        }\r\n    }\r\n    \r\n    super.ucCliCustom(params, out, delim, dbconn, session);\r\n}<\/code>\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Purpose Exit to control customizing calls by way of the Application Programming Interface, or the Command Line Interface. Applies To CLI Methods Signature public void ucCliCustom ( HashMap parms, PrintWriter out, String delim, Connection dbconn, SesameSession session) Notes This method is called from the CLI when a statevar of custom is passed. Results are written&#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-24533","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>ucCliCustom - 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\/ucclicustom-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"ucCliCustom - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"Purpose Exit to control customizing calls by way of the Application Programming Interface, or the Command Line Interface. Applies To CLI Methods Signature public void ucCliCustom ( HashMap parms, PrintWriter out, String delim, Connection dbconn, SesameSession session) Notes This method is called from the CLI when a statevar of custom is passed. Results are written...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucclicustom-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=\"2 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\/ucclicustom-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucclicustom-1\/\",\"name\":\"ucCliCustom - 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\/ucclicustom-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\/ucclicustom-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucclicustom-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\":\"ucCliCustom\"}]},{\"@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":"ucCliCustom - 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\/ucclicustom-1\/","og_locale":"en_US","og_type":"article","og_title":"ucCliCustom - Product Documentation","og_description":"Purpose Exit to control customizing calls by way of the Application Programming Interface, or the Command Line Interface. Applies To CLI Methods Signature public void ucCliCustom ( HashMap parms, PrintWriter out, String delim, Connection dbconn, SesameSession session) Notes This method is called from the CLI when a statevar of custom is passed. Results are written...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucclicustom-1\/","og_site_name":"Product Documentation","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 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\/ucclicustom-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucclicustom-1\/","name":"ucCliCustom - 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\/ucclicustom-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\/ucclicustom-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucclicustom-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":"ucCliCustom"}]},{"@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\/24533","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=24533"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24533\/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=24533"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}