/
JSON

JSON

Owned by Silvia Neag (Unlicensed)
Last updated: Mar 21, 2025 by wiki

Activities



AddJsonNode

This activity adds a JSON node at a specified path in the JSON source file.

.

Activity Parameters

The AddJsonNode activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Filename (text box editor type) (type: string): (Optional) Enter the file name only if you want to apply the changes to an external disk source.
  • FilePath (text box editor type) (type: string): Enter the disk path of the json file you wish to use as source for this activity. This takes precedence over the JsonString parameter.
  • NodeName (text box editor type) (type: string): Enter the node name.
  • Save Folder Path (text box editor type) (type: string): (Optional) Specifies a path on disk where the json file should be saved.
  • Value (text box editor type) (type: string): Enter the text value of the node.
  • JsonString (text box editor type) (type: string): Enter the Input JSON string.This parameter should be bound to a Resulting JSON String output parameter from a JSON activity.
  • XPath (text box editor type) (type: string): Enter the XPath where you wish the node to be inserted. If the path doesn't exist, the inexistent parts will be created. For example: root.node_name.other_node_name. In case of more root elements included in an array, you can specify which element to use as follows [0].root.node_name.

The Read Only Output variable are the possible output values that the activity will provide:

  • Resulting JSON string (type: string): Outputs the resulting JSON String.(This parameter can be used as Input for JsonString input parameter for activities under JSON category). If you want to display the value of the output parameter use any logging activity that displays string values. E.g. LogTrackData activity.

 

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables or input directly in the property field. E.g. "JsonExample" for Filename property.

XML To JSON

This activity convert a xml string into a json string.

.

Activity Parameters

The XML To JSON activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • FilePath (text box editor type) (type: string): Enter the disk path of the json file you wish to use as source for this activity. This takes precedence over the JsonString parameter.
  • XML String (text box editor type) (type: string): Input XML String.
  • XPath (text box editor type) (type: string): Enter the XPath where you wish the node to be inserted. If the path doesn't exist, the inexistent parts will be created. For example: root.node_name.other_node_name. In case of more root elements included in an array, you can specify which element to use as follows [0].root.node_name.

The Read Only Output variable are the possible output values that the activity will provide:

  • JObject (type: JObject): Returns the XML String as JObject.
  • JSON as String (type: string): Returns the JSON Object as String.


CreateJson

This activity creates a blank JSON string with a specified root element and heading. Optionally can be saved on disk.

Activity Parameters

The CreateJson activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Filename (text box editor type) (type: string): (Optional) Enter the file name only if you want to apply the changes to an external disk source.
  • FolderPath (text box editor type) (type: string): (Optional) Specifies a path on disk where the json file should be saved. Leave empty if you do not wish to save on disk.
  • Overwrite (combo-box editor type): Overwrites the file if it already exists. 
  • Root (text box editor type) (type: string): Enter the root name.


The Read Only Output variable are the possible output values that the activity will provide:

  • Resulting JSON string (type: string): Outputs the resulting JSON String.(This parameter can be used as Input for JsonString input parameter for activities under JSON category). If you want to display the value of the output parameter use any logging activity that displays string values. E.g. LogTrackData activity.

 

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables or input directly in the property field. E.g. "JsonExample" for Filename property.


 

EditJsonNodeValue

This activity edits the value of the given node by a certain XPath.

Activity Parameters

The EditJsonNodeValue activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Filename (text box editor type) (type: string): (Optional) Enter the file name only if you want to apply the changes to an external disk source.
  • FilePath (text box editor type) (type: string): Enter the disk path of the json file you wish to use as source for this activity. This takes precedence over the JsonString parameter.
  • Folder Path (text box editor type) (type: string): (Optional) Specifies a path on disk where the json file should be saved. Leave empty if you do not wish to save on disk.
  • Value (text box editor type) (type: string): Enter the text value of the node.
  • Value String Formatted (text box editor type) (type: string): the text value of the node if a binding to a variable is used ($using). If set and if the $using:variable syntax is used, this parameter will take precedence over the Value parameter. For example, the $using:DemoString syntax will take the value stored in the DemoString variable and will execute it:
  • JsonString (text box editor type) (type: string): Enter the Input JSON string.This parameter should be bound to a Resulting JSON String output parameter from a JSON activity.
  • Json String Formatted (text box editor type) (type: string): the JSON string input if a binding to a variable is used ($using). If set and if the $using:variable syntax is used, this parameter will take precedence over the Json String parameter. For example, the $using:DemoStringNode syntax will take the value stored in the DemoStringNode variable and will execute it:
     
  • XPath (text box editor type) (type: string): Enter the XPath where you wish the node to be inserted. If the path doesn't exist, the inexistent parts will be created. For example: root.node_name.other_node_name. In case of more root elements included in an array, you can specify which element to use as follows [0].root.node_name.


The Read Only Output variable are the possible output values that the activity will provide:

  • Resulting JSON string (type: string): Outputs the resulting JSON String.(This parameter can be used as Input for JsonString input parameter for activities under JSON category). If you want to display the value of the output parameter use any logging activity that displays string values. E.g. LogTrackData activity.

 

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables or input directly in the property field. E.g. "JsonExample" for Filename property.


 
 

FindJsonNodes

This activity returns a collection of nodes according to some given filters.

Activity Parameters

The FindJsonNodes activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • FilePath (text box editor type) (type: string): Enter the disk path of the json file you wish to use as source for this activity. This takes precedence over the JsonString parameter.
  • JsonString (text box editor type) (type: string): Enter the Input JSON string.This parameter should be bound to a Resulting JSON String output parameter from a JSON activity.
  • XPath (text box editor type) (type: string): Enter the XPath where you wish the node to be inserted. If the path doesn't exist, the inexistent parts will be created. For example: root.node_name.other_node_name. In case of more root elements included in an array, you can specify which element to use as follows [0].root.node_name.


The Read Only Output variable are the possible output values that the activity will provide:

  • JsonNodes (type: collection<string>): Outputs a collection of JSON strings of the nodes that correspond to the searching filters. To use the elements of the collection, use Get Element From Collection activity to extract a specific element or use any iteration activity to iterate through the elements of the collection.
  • OutputElementCount (type: Int32):  Outputs an integer equal to the number of Json Nodes found.

Use the following workflow logic as example to iterate through the elements of the collection and display the collection number. For more information on how to use Custom ForEach activity please check Workflow link.

 


As mentioned above, the values for all the required parameters can be provided by IN arguments or variables or input directly in the property field. E.g. "RootNode_Json" for XPath property.


GetJSONNodeValue 

This activity gets the text value of a given json node.

Activity Parameters

The GetJSONNodeValue activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • FilePath (text box editor type) (type: string): Enter the disk path of the json file you wish to use as source for this activity. This takes precedence over the JsonString parameter.

  • JsonString (text box editor type) (type: string): Enter the Input JSON string.This parameter should be bound to a Resulting JSON String output parameter from a JSON activity.

  • XPath (text box editor type) (type: string): Enter the XPath where you wish the node to be inserted. If the path doesn't exist, the inexistent parts will be created. For example: root.node_name.other_node_name. In case of more root elements included in an array, you can specify which element to use as follows [0].root.node_name.


The Read Only Output variable are the possible output values that the activity will provide:

  • NodeValue (type: string): Outputs the text value of a given node. If you want to display the value of the output parameter use any logging activity that displays string values. E.g. LogTrackData activity.

 


As mentioned above, the values for all the required parameters can be provided by IN arguments or variables or input directly in the property field. E.g. "RootNode_Json.Node1" for XPath property.


ImportJSON 

This activity imports data from a given json file.

Activity Parameters

The ImportJSON activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • JSON File (text box editor type) (type: string): Specify the full path (including the filename) of the json file.


The Read Only Output variable are the possible output values that the activity will provide:

  • Output (type: string): Outputs a JSON string. If you want to display the value of the output parameter use any logging activity that displays string values. E.g. LogTrackData activity.

 


As mentioned above, the values for all the required parameters can be provided by IN arguments or variables or input directly in the property field. E.g. "C:\testing\File.json" for XPath property.

JSON String To JArray

This activity convert a JSON string into a JArray. This allow to use the Custom Foreach Activity with an iterator of type jtoken to work with it.

.

Activity Parameters

The JSON String To JArray activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • JSON String (text box editor type) (type: string): Input JSON String.
  • XPath (text box editor type) (type: string): Enter the XPath where you wish the node to be inserted. If the path doesn't exist, the inexistent parts will be created. For example: root.node_name.other_node_name. In case of more root elements included in an array, you can specify which element to use as follows [0].root.node_name.

The Read Only Output variable are the possible output values that the activity will provide:

  • JArray (type: JArray): Returns the JSON String as JArray

JSON String To JObject

This activity convert a JSON string into a JObject. This makes it possible to access the Notes directly via the name. E.g.: myJObject(“Nodename”)(“subnode”)

.

Activity Parameters

The JSON String To JObject activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • FilePath (text box editor type) (type: string): Enter the disk path of the json file you wish to use as source for this activity. This takes precedence over the JsonString parameter.
  • JSONNodeString (text box editor type) (type: string): Input JSON String.
  • XPath (text box editor type) (type: string): Enter the XPath where you wish the node to be inserted. If the path doesn't exist, the inexistent parts will be created. For example: root.node_name.other_node_name. In case of more root elements included in an array, you can specify which element to use as follows [0].root.node_name.

The Read Only Output variable are the possible output values that the activity will provide:

  • JObject (type: JObject): Returns the JSON String as JObject


RemoveJsonNode

This activity removes a JSON node given by a specific XPath.

.

Activity Parameters

The RemoveJsonNode activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Filename (text box editor type) (type: string): (Optional) Enter the file name only if you want to apply the changes to an external disk source.
  • FilePath (text box editor type) (type: string): Enter the disk path of the json file you wish to use as source for this activity. This takes precedence over the JsonString parameter.
  • Folder Path (text box editor type) (type: string): (Optional) Specifies a path on disk where the json file should be saved.
  • JsonString (text box editor type) (type: string): Enter the Input JSON string.This parameter should be bound to a Resulting JSON String output parameter from a JSON activity.
  • XPath (text box editor type) (type: string): Enter the XPath where you wish the node to be inserted. If the path doesn't exist, the inexistent parts will be created. For example: root.node_name.other_node_name. In case of more root elements included in an array, you can specify which element to use as follows [0].root.node_name.

The Read Only Output variable are the possible output values that the activity will provide:

  • Resulting JSON string (type: string): Outputs the resulting JSON String.(This parameter can be used as Input for JsonString input parameter for activities under JSON category). If you want to display the value of the output parameter use any logging activity that displays string values. E.g. LogTrackData activity.

 


As mentioned above, the values for all the required parameters can be provided by IN arguments or variables or input directly in the property field. E.g. "JsonExample" for Filename property.


Related content