{"id":4185,"date":"2023-11-13T20:28:00","date_gmt":"2023-11-13T20:28:00","guid":{"rendered":"https:\/\/quebit.com\/askquebit\/?p=4185"},"modified":"2026-01-20T15:58:32","modified_gmt":"2026-01-20T15:58:32","slug":"creating-reusable-custom-code-snippets-for-paw","status":"publish","type":"post","link":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/","title":{"rendered":"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)?"},"content":{"rendered":"

Custom Code Snippets for Planning Analytics Workspace<\/strong><\/p>\n

With the release of Planning Analytics Workspace version 2.0.88, the ability to upload and use custom code snippets was added to the Workbench in Planning Analytics Workspace. In previous releases, there was only a select amount of code snippets to choose from. After creating and uploading a custom code snippet as a JSON file, that portion of code can be used in any process available on the database. This functionality is accessible via the \u201cAdd snippet\u201d dropdown available while editing a TI Process.<\/p>\n

\"\"<\/p>\n

Creating a Custom Code Snippet<\/strong><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/strong>\u00a0To create a custom code snippet, start by creating a JSON file using a text editor. The file must be populated with several objects and properties, not all of which are required. Here are the contents of a sample code snippet JSON file that will be referenced throughout this article:<\/p>\n

\"\"
\n\"\"<\/p>\n

\"\"<\/p>\n

\"\"<\/p>\n

\"\"<\/p>\n

\"\"<\/strong><\/p>\n

Uploading a Custom Code Snippet<\/strong><\/p>\n

After creating a JSON file with all of the required components, the snippet can be uploaded into PAW for use. To do so, open any process in a workbench, preferably one you want to add the new snippet to. In the top right of the process click the \u201cAdd snippet\u201d button and then select \u201cCustom\u201d.<\/p>\n

\"\"<\/p>\n

\"\"<\/p>\n

In the Snippet manager screen that appears, select a folder to upload the snippet to (optional). Then on the top right of the screen click the \u201cUpload snippets\u201d button.<\/p>\n

Drag and drop or browse and select from the file manager the snippet(s) that are to be uploaded. Then click the \u201cUpload\u201d button to confirm and upload.<\/p>\n

\"\"<\/p>\n

A checkmark will appear next to the snippets that upload correctly. If an error appears, it is likely that there is a syntax error, or a required component was not included within the JSON file for the snippet. Once uploaded, the snippet will now be present and available to use in the snippet manager window.<\/p>\n

\"\" \"\"<\/p>\n

To add the snippet to a process, simply open the custom snippet manager window from the process that the snippet should be added to, with the cursor on the line the snippet is to be added. Then select the box next to the desired snippet and click the \u201cSelect\u201d button.<\/p>\n

\"\"\u00a0 \u00a0 \u00a0\"\"<\/p>\n

This will open the \u201cInsert snippet\u201d window. Below is an image describing the components of this window that were defined in the sample code snippet above. If required, the values for each variable can be updated to alter the code snippet. In the case below, \u201cnull\u201d would be replaced with any string value entered in the \u201cValue\u201d box for the vText variable. The preview portion of the window will update with any changes to the variables as they are made.<\/p>\n

\"\"<\/p>\n

After confirming any variables are updated accordingly, click the \u201cInsert\u201d button on the bottom right of the window to insert the snippet into the code.<\/p>\n

\"\"\u00a0 \u00a0 \u00a0 \"\"<\/p>\n

Note that if an auxiliary variable already exists in the process with the same name, the Insert snippet window will automatically change the variable to be unique. It does this by appending \u201c_exists_#####\u201d to the end of the variable name, where # is a random alphanumerical character.<\/p>\n

\"\"<\/p>\n

After adding snippets to the code, be sure to save the process to commit any changes.<\/p>\n","protected":false},"excerpt":{"rendered":"

Custom Code Snippets for Planning Analytics Workspace With the release of Planning Analytics Workspace version 2.0.88, the ability to upload and use custom code snippets was added to the Workbench in Planning Analytics Workspace. In previous releases, there was only a select amount of code snippets to choose from. After creating and uploading a custom…<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[24],"tags":[51],"class_list":["post-4185","post","type-post","status-publish","format-standard","hentry","category-ibm","tag-planning-analytics-how-tos"],"acf":[],"yoast_head":"\nHow Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)? - QueBIT<\/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:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)? - QueBIT\" \/>\n<meta property=\"og:description\" content=\"Custom Code Snippets for Planning Analytics Workspace With the release of Planning Analytics Workspace version 2.0.88, the ability to upload and use custom code snippets was added to the Workbench in Planning Analytics Workspace. In previous releases, there was only a select amount of code snippets to choose from. After creating and uploading a custom…\" \/>\n<meta property=\"og:url\" content=\"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/\" \/>\n<meta property=\"og:site_name\" content=\"QueBIT\" \/>\n<meta property=\"article:published_time\" content=\"2023-11-13T20:28:00+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2026-01-20T15:58:32+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2023\/11\/Picture1.png\" \/>\n\t<meta property=\"og:image:width\" content=\"250\" \/>\n\t<meta property=\"og:image:height\" content=\"250\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Jennifer Field\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Jennifer Field\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"6 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/\"},\"author\":{\"name\":\"Jennifer Field\",\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/#\\\/schema\\\/person\\\/082a9c4156466b9cdad2632e3de62601\"},\"headline\":\"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)?\",\"datePublished\":\"2023-11-13T20:28:00+00:00\",\"dateModified\":\"2026-01-20T15:58:32+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/\"},\"wordCount\":546,\"commentCount\":0,\"image\":{\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/wp-content\\\/uploads\\\/2023\\\/11\\\/Picture1.png\",\"keywords\":[\"Planning Analytics How To's\"],\"articleSection\":[\"IBM\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/\",\"url\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/\",\"name\":\"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)? - QueBIT\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/wp-content\\\/uploads\\\/2023\\\/11\\\/Picture1.png\",\"datePublished\":\"2023-11-13T20:28:00+00:00\",\"dateModified\":\"2026-01-20T15:58:32+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/#\\\/schema\\\/person\\\/082a9c4156466b9cdad2632e3de62601\"},\"breadcrumb\":{\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/#primaryimage\",\"url\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/wp-content\\\/uploads\\\/2023\\\/11\\\/Picture1.png\",\"contentUrl\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/wp-content\\\/uploads\\\/2023\\\/11\\\/Picture1.png\",\"width\":250,\"height\":250},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/creating-reusable-custom-code-snippets-for-paw\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/#website\",\"url\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/\",\"name\":\"QueBIT\",\"description\":\"QueBIT\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/#\\\/schema\\\/person\\\/082a9c4156466b9cdad2632e3de62601\",\"name\":\"Jennifer Field\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/02bd32c7255ad906cd2c6352f643559cfee048a9b227b5b07b6a6f48d5b4a658?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/02bd32c7255ad906cd2c6352f643559cfee048a9b227b5b07b6a6f48d5b4a658?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/02bd32c7255ad906cd2c6352f643559cfee048a9b227b5b07b6a6f48d5b4a658?s=96&d=mm&r=g\",\"caption\":\"Jennifer Field\"},\"url\":\"https:\\\/\\\/quebit.com\\\/askquebit\\\/author\\\/quebit\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)? - QueBIT","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:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/","og_locale":"en_US","og_type":"article","og_title":"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)? - QueBIT","og_description":"Custom Code Snippets for Planning Analytics Workspace With the release of Planning Analytics Workspace version 2.0.88, the ability to upload and use custom code snippets was added to the Workbench in Planning Analytics Workspace. In previous releases, there was only a select amount of code snippets to choose from. After creating and uploading a custom…","og_url":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/","og_site_name":"QueBIT","article_published_time":"2023-11-13T20:28:00+00:00","article_modified_time":"2026-01-20T15:58:32+00:00","og_image":[{"width":250,"height":250,"url":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2023\/11\/Picture1.png","type":"image\/png"}],"author":"Jennifer Field","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Jennifer Field","Est. reading time":"6 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/#article","isPartOf":{"@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/"},"author":{"name":"Jennifer Field","@id":"https:\/\/quebit.com\/askquebit\/#\/schema\/person\/082a9c4156466b9cdad2632e3de62601"},"headline":"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)?","datePublished":"2023-11-13T20:28:00+00:00","dateModified":"2026-01-20T15:58:32+00:00","mainEntityOfPage":{"@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/"},"wordCount":546,"commentCount":0,"image":{"@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/#primaryimage"},"thumbnailUrl":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2023\/11\/Picture1.png","keywords":["Planning Analytics How To's"],"articleSection":["IBM"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/","url":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/","name":"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)? - QueBIT","isPartOf":{"@id":"https:\/\/quebit.com\/askquebit\/#website"},"primaryImageOfPage":{"@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/#primaryimage"},"image":{"@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/#primaryimage"},"thumbnailUrl":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2023\/11\/Picture1.png","datePublished":"2023-11-13T20:28:00+00:00","dateModified":"2026-01-20T15:58:32+00:00","author":{"@id":"https:\/\/quebit.com\/askquebit\/#\/schema\/person\/082a9c4156466b9cdad2632e3de62601"},"breadcrumb":{"@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/#primaryimage","url":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2023\/11\/Picture1.png","contentUrl":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2023\/11\/Picture1.png","width":250,"height":250},{"@type":"BreadcrumbList","@id":"https:\/\/quebit.com\/askquebit\/creating-reusable-custom-code-snippets-for-paw\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/quebit.com\/askquebit\/"},{"@type":"ListItem","position":2,"name":"How Do I Create Reusable Custom Code Snippets for Planning Analytics Workspace (PAW)?"}]},{"@type":"WebSite","@id":"https:\/\/quebit.com\/askquebit\/#website","url":"https:\/\/quebit.com\/askquebit\/","name":"QueBIT","description":"QueBIT","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/quebit.com\/askquebit\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/quebit.com\/askquebit\/#\/schema\/person\/082a9c4156466b9cdad2632e3de62601","name":"Jennifer Field","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/02bd32c7255ad906cd2c6352f643559cfee048a9b227b5b07b6a6f48d5b4a658?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/02bd32c7255ad906cd2c6352f643559cfee048a9b227b5b07b6a6f48d5b4a658?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/02bd32c7255ad906cd2c6352f643559cfee048a9b227b5b07b6a6f48d5b4a658?s=96&d=mm&r=g","caption":"Jennifer Field"},"url":"https:\/\/quebit.com\/askquebit\/author\/quebit\/"}]}},"_links":{"self":[{"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/posts\/4185","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/comments?post=4185"}],"version-history":[{"count":3,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/posts\/4185\/revisions"}],"predecessor-version":[{"id":5072,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/posts\/4185\/revisions\/5072"}],"wp:attachment":[{"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/media?parent=4185"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/categories?post=4185"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/tags?post=4185"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}