From 53a3f2316f15ce59c85dab4afecffce54cb9dd87 Mon Sep 17 00:00:00 2001 From: rjmurray Date: Mon, 13 Jan 2025 16:40:30 +0000 Subject: [PATCH] updaing help.md --- plugins/string/.CHECKSUM | 4 +-- plugins/string/help.md | 35 +++++++++++-------- .../actions/split_to_object/schema.py | 2 +- plugins/string/plugin.spec.yaml | 4 ++- 4 files changed, 26 insertions(+), 19 deletions(-) diff --git a/plugins/string/.CHECKSUM b/plugins/string/.CHECKSUM index dc62cc3956..817e207ce7 100644 --- a/plugins/string/.CHECKSUM +++ b/plugins/string/.CHECKSUM @@ -1,5 +1,5 @@ { - "spec": "af4772c66e6dfae2a41dbc24c4fafde9", + "spec": "c957502ef3eb0b416e91445e327d1d7a", "manifest": "ff9feb5c62cc6078a3212085652011c3", "setup": "394787d1ead943699cecc2712c114b1b", "schemas": [ @@ -25,7 +25,7 @@ }, { "identifier": "split_to_object/schema.py", - "hash": "69e573420b92e9c831d81e095534f76b" + "hash": "41201592318a69a4d5e9cb62d214b600" }, { "identifier": "trim/schema.py", diff --git a/plugins/string/help.md b/plugins/string/help.md index e965a31461..d7dbaab042 100644 --- a/plugins/string/help.md +++ b/plugins/string/help.md @@ -207,21 +207,7 @@ Example output: #### Split String to Object -This action is used to convert a string to an object containing key:value strings. - -Any input requiring more than a -single key:value pair, e.g. `USER=Bob` needs to use the `block_delimiter` option. -In this case, the input string is -split by the `block_delimiter` character first, and the resulting items are then split -by the `string_delimiter` option. - Stripping of double-quotes is automatically applied in this situation for each item before the plugin returns it. -The -[output schema](https://docs.komand.com/v0.42.1/docs/python-script-plugins#section-configure-the-plugin-output-schema) -on the action's page can be modified to pre-populate the workflow with the names of the keys. -It allows users the -ability to use the green selector and choose a specific variable later in the workflow by name. -[Input -templating](https://docs.komand.com/docs/input-templating) would need to be used to obtain variables by name otherwise +This action is used to convert a string to an object containing key:value strings ##### Input @@ -334,6 +320,25 @@ Example output: ## Troubleshooting * There may be complex string manipulation needs that are likely outside the scope of this plugin. If this is the case, consider using the Python 3 Script plugin instead. +* For the `Split String to Object` action:, + +Any input requiring more than a single key:value pair, e.g. `USER=Bob` needs to use the `block_delimiter` option. +In this case, the input string is split by the `block_delimiter` character first, and the resulting items are then split +by the `string_delimiter` option. Stripping of double-quotes is automatically applied in this situation for each item before the plugin returns it. + +The [output schema](https://docs.komand.com/v0.42.1/docs/python-script-plugins#section-configure-the-plugin-output-schema) on the action's page can be modified to pre-populate the workflow with the names of the keys. +It allows users the ability to use the green selector and choose a specific variable later in the workflow by name. +[Input templating](https://docs.komand.com/docs/input-templating) would need to be used to obtain variables by name otherwise + +* More complex string input that contains multiple key:value pairs. These pairs are separated from each other by a space, and the keys and values within each pair are separated by an equal sign: + + ```Computer_ID="bef41e8b-47b8-e188-8e43-3a2b662dd55d" Computer_Name="dgdemo RGWin64" Computer_Type="Windows" ``` + + Setting `block_delimiter` to ` ` and `string_delimiter` to `=` will return the information presented in the example below. + + Example output: + + ``` { "object": { "Computer_ID": "bef41e8b-47b8-e188-8e43-3a2b662dd55d", "Computer_Name": "dgdemo RGWin64", "Computer_Type": "Windows" } } ``` # Version History diff --git a/plugins/string/komand_string/actions/split_to_object/schema.py b/plugins/string/komand_string/actions/split_to_object/schema.py index d13e1be9c9..81e15d18c2 100755 --- a/plugins/string/komand_string/actions/split_to_object/schema.py +++ b/plugins/string/komand_string/actions/split_to_object/schema.py @@ -4,7 +4,7 @@ class Component: - DESCRIPTION = "This action is used to convert a string to an object containing key:value strings.Any input requiring more than a single key:value pair, e.g. `USER=Bob` needs to use the `block_delimiter` option.In this case, the input string is split by the `block_delimiter` character first, and the resulting items are then splitby the `string_delimiter` option. Stripping of double-quotes is automatically applied in this situation for each item before the plugin returns it.The [output schema](https://docs.komand.com/v0.42.1/docs/python-script-plugins#section-configure-the-plugin-output-schema) on the action's page can be modified to pre-populate the workflow with the names of the keys.It allows users the ability to use the green selector and choose a specific variable later in the workflow by name.[Input templating](https://docs.komand.com/docs/input-templating) would need to be used to obtain variables by name otherwise" + DESCRIPTION = "This action is used to convert a string to an object containing key:value strings" class Input: diff --git a/plugins/string/plugin.spec.yaml b/plugins/string/plugin.spec.yaml index ef8ad322dd..425fde7081 100644 --- a/plugins/string/plugin.spec.yaml +++ b/plugins/string/plugin.spec.yaml @@ -45,6 +45,8 @@ version_history: - "1.0.0 - Initial plugin" troubleshooting: - "There may be complex string manipulation needs that are likely outside the scope of this plugin. If this is the case, consider using the Python 3 Script plugin instead." + - "For the `Split String to Object` action:, \n\nAny input requiring more than a single key:value pair, e.g. `USER=Bob` needs to use the `block_delimiter` option.\nIn this case, the input string is split by the `block_delimiter` character first, and the resulting items are then split\nby the `string_delimiter` option. Stripping of double-quotes is automatically applied in this situation for each item before the plugin returns it.\n\nThe [output schema](https://docs.komand.com/v0.42.1/docs/python-script-plugins#section-configure-the-plugin-output-schema) on the action's page can be modified to pre-populate the workflow with the names of the keys.\nIt allows users the ability to use the green selector and choose a specific variable later in the workflow by name.\n[Input templating](https://docs.komand.com/docs/input-templating) would need to be used to obtain variables by name otherwise\n" + - "More complex string input that contains multiple key:value pairs. These pairs are separated from each other by a space, and the keys and values within each pair are separated by an equal sign:\n\n ```Computer_ID=\"bef41e8b-47b8-e188-8e43-3a2b662dd55d\" Computer_Name=\"dgdemo\ RGWin64\" Computer_Type=\"Windows\" ``` \n\n Setting `block_delimiter` to ` ` and `string_delimiter` to `=` will return the information presented in the example below.\n\n Example output: \n\n ``` { \"object\": { \"Computer_ID\": \"bef41e8b-47b8-e188-8e43-3a2b662dd55d\", \"Computer_Name\": \"dgdemo\ RGWin64\", \"Computer_Type\": \"Windows\" } } ```" links: - "[Python 3 String Methods](https://docs.python.org/3/library/stdtypes.html#string-methods)" references: @@ -110,7 +112,7 @@ actions: example: '["This", "is", "a", "sentence"]' split_to_object: title: Split String to Object - description: "This action is used to convert a string to an object containing key:value strings.\n\nAny input requiring more than a single key:value pair, e.g. `USER=Bob` needs to use the `block_delimiter` option.\nIn this case, the input string is split by the `block_delimiter` character first, and the resulting items are then split\nby the `string_delimiter` option. Stripping of double-quotes is automatically applied in this situation for each item before the plugin returns it.\nThe [output schema](https://docs.komand.com/v0.42.1/docs/python-script-plugins#section-configure-the-plugin-output-schema) on the action's page can be modified to pre-populate the workflow with the names of the keys.\nIt allows users the ability to use the green selector and choose a specific variable later in the workflow by name.\n[Input templating](https://docs.komand.com/docs/input-templating) would need to be used to obtain variables by name otherwise" + description: "This action is used to convert a string to an object containing key:value strings" input: string: title: String Input