{"_id":"5b28df7194e1f7000317f963","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":40,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"55faf96917b9d00d00969f48","pages":["5626a5d644c87f0d00fe6396","5626a5e4e2ce610d004e3dd8","5626a89ce2ce610d004e3dde","56429a87f49bfa0d002f54e0"],"project":"55faf11ba62ba1170021a9a7","__v":4,"version":"55faf11ba62ba1170021a9aa","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-17T17:33:29.016Z","from_sync":false,"order":20,"slug":"run-an-analysis","title":"RUN AN ANALYSIS"},"user":"5767bc73bb15f40e00a28777","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-19T10:48:17.625Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"The second tab on the **Draft Task** page, **Define App Settings**, allows you to see each tool's parameters and edit those parameters that have been marked to be **exposed** at runtime.\n\nIf there are exposed parameters, they will be displayed in edit mode and you are able to set their values immediately. Settings that are required by the tool are marked in red, such as the **instance_num** field in the example below. Other fields may be left empty - doing this means that the tool will use its default value for the setting.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you are describing a tool that you've added to the CGC with the **Tool Editor**, you can describe the tool's default value in the field **Tool Default**, on the output port corresponding to that parameter. Note that this field lets you describe the default value. It doesn't let you set the default.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/af17714-define-app-settings-1.png\",\n        \"define-app-settings-1.png\",\n        1017,\n        745,\n        \"#112a47\"\n      ]\n    }\n  ]\n}\n[/block]\nFor each of the nodes you are able to see its current descriptive name and its workflow name (displayed in brackets). You can use the options in the dropdown list to configure which app settings are displayed:\n\n* **Show all** - Displays all editable and non-editable parameters.\n* **Show editable** - Displays editable parameters in _view_ mode.\n* **Show non-default** - Displays parameters whose values have been modified compared to the default ones.\n\n<a name=\"set-null-or-empty\"></a>When any of these options is selected, you can still click **Edit Parameters**, which will display the editable parameters only, and allow you enter their values. Depending on how your app is configured, you might also want to set null or empty values for some input parameters. This is possible using the following buttons:\n\n* <img src=\"https://files.readme.io/04534bc-null-icon.png\"\nheight=\"12px\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> (**Set null**) - Sets the value of the input parameter to null.\n* <img src=\"https://files.readme.io/ffeecb9-empty-icon.png\"\nheight=\"10px\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> (**Set empty**) - Sets the value of the input parameter to empty. \n\nThe **Set null** option is available both for simple input values (such as strings or numeric values) and complex ones (such as arrays, records or maps). This means that you can also set the **null** value for an input parameter whose type is e.g. array. \n\n**Set empty** is available as a button only for complex inputs (arrays, records and maps). For simple app parameters, such as strings, just leave the field blank and the value will be treated as an empty string. However, in case of numeric input parameters, removing all numbers from the input will set the value to **null**, the same as a click on the **Set null** button. This conforms with the expected behavior for numeric values, which are supposed to be either defined or null, but not empty.\n\nOnce you have entered app settings and set input data, click **Run** in the bottom right hand corner to initiate the execution.","excerpt":"","slug":"define-app-settings","type":"basic","title":"Define app settings"}

Define app settings


The second tab on the **Draft Task** page, **Define App Settings**, allows you to see each tool's parameters and edit those parameters that have been marked to be **exposed** at runtime. If there are exposed parameters, they will be displayed in edit mode and you are able to set their values immediately. Settings that are required by the tool are marked in red, such as the **instance_num** field in the example below. Other fields may be left empty - doing this means that the tool will use its default value for the setting. [block:callout] { "type": "info", "body": "If you are describing a tool that you've added to the CGC with the **Tool Editor**, you can describe the tool's default value in the field **Tool Default**, on the output port corresponding to that parameter. Note that this field lets you describe the default value. It doesn't let you set the default." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/af17714-define-app-settings-1.png", "define-app-settings-1.png", 1017, 745, "#112a47" ] } ] } [/block] For each of the nodes you are able to see its current descriptive name and its workflow name (displayed in brackets). You can use the options in the dropdown list to configure which app settings are displayed: * **Show all** - Displays all editable and non-editable parameters. * **Show editable** - Displays editable parameters in _view_ mode. * **Show non-default** - Displays parameters whose values have been modified compared to the default ones. <a name="set-null-or-empty"></a>When any of these options is selected, you can still click **Edit Parameters**, which will display the editable parameters only, and allow you enter their values. Depending on how your app is configured, you might also want to set null or empty values for some input parameters. This is possible using the following buttons: * <img src="https://files.readme.io/04534bc-null-icon.png" height="12px" width="auto" align="inline" style="margin:1px"/> (**Set null**) - Sets the value of the input parameter to null. * <img src="https://files.readme.io/ffeecb9-empty-icon.png" height="10px" width="auto" align="inline" style="margin:1px"/> (**Set empty**) - Sets the value of the input parameter to empty.  The **Set null** option is available both for simple input values (such as strings or numeric values) and complex ones (such as arrays, records or maps). This means that you can also set the **null** value for an input parameter whose type is e.g. array.  **Set empty** is available as a button only for complex inputs (arrays, records and maps). For simple app parameters, such as strings, just leave the field blank and the value will be treated as an empty string. However, in case of numeric input parameters, removing all numbers from the input will set the value to **null**, the same as a click on the **Set null** button. This conforms with the expected behavior for numeric values, which are supposed to be either defined or null, but not empty. Once you have entered app settings and set input data, click **Run** in the bottom right hand corner to initiate the execution.