{"id":52,"date":"2010-02-25T13:33:22","date_gmt":"2010-02-25T03:33:22","guid":{"rendered":"http:\/\/supportingelement.wordpress.com\/?p=52"},"modified":"2010-02-25T13:33:22","modified_gmt":"2010-02-25T03:33:22","slug":"documentation-tool","status":"publish","type":"post","link":"https:\/\/supportingelement.com\/index.php\/2010\/02\/25\/documentation-tool\/","title":{"rendered":"Documentation Tool"},"content":{"rendered":"

One of the best ways to document GP Configuration is to put an\u00a0explanation\u00a0into the “Comments” of the Elements. \u00a0This makes it easier for those who follow in your foot sets to understand the configuration without looking in archives and searching through documents formatted by Project Managers who think paper grows on trees :-P.<\/p>\n

However, I have never met a Project Manager that doesn’t want a hard copy Design Document for their customer to sign-off.<\/p>\n

Element Comments are stored in the Database as a “CLOB”, making them difficult to extract. \u00a0The following script extracts Comments from the CLOB using the “TO_CHAR” function.<\/p>\n\n\n\n
\n
SELECT PIN_NM, DESCR, TO_CHAR(COMMENTS)<\/em><\/div>\n
FROM PS_GP_PIN<\/em><\/div>\n
WHERE LENGTH(TO_CHAR(COMMENTS)) > 0<\/em><\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Run this script from your SQL Client… \u00a0you are then just a cut and paste away from finishing your Design Document.<\/p>\n","protected":false},"excerpt":{"rendered":"

One of the best ways to document GP Configuration is to put an\u00a0explanation\u00a0into the “Comments” of the Elements. \u00a0This makes it easier for those who follow in your foot sets to understand the configuration without looking in archives and searching through documents formatted by Project Managers who think paper grows on trees :-P. However, I\u2026 Read More »<\/a><\/span><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3,1],"tags":[],"class_list":["post-52","post","type-post","status-publish","format-standard","hentry","category-all-posts","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/supportingelement.com\/index.php\/wp-json\/wp\/v2\/posts\/52","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/supportingelement.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/supportingelement.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/supportingelement.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/supportingelement.com\/index.php\/wp-json\/wp\/v2\/comments?post=52"}],"version-history":[{"count":0,"href":"https:\/\/supportingelement.com\/index.php\/wp-json\/wp\/v2\/posts\/52\/revisions"}],"wp:attachment":[{"href":"https:\/\/supportingelement.com\/index.php\/wp-json\/wp\/v2\/media?parent=52"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/supportingelement.com\/index.php\/wp-json\/wp\/v2\/categories?post=52"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/supportingelement.com\/index.php\/wp-json\/wp\/v2\/tags?post=52"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}