Difference between revisions of "Component: XML JSON Parser (Runtime Tools)"

From Flowcode Help
Jump to navigationJump to search
 
(2 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
==XML JSON Parser component==
 
==XML JSON Parser component==
 
A component designed to simplify the collection of data from XML and JSON sources. Parses the raw data and creates a dynamic representation of the data that is easy to navigate and interrogate. Also allows the objects to be manually created or edited and then re-exported as XML or JSON format.
 
A component designed to simplify the collection of data from XML and JSON sources. Parses the raw data and creates a dynamic representation of the data that is easy to navigate and interrogate. Also allows the objects to be manually created or edited and then re-exported as XML or JSON format.
 +
 +
==Component Pack==
 +
 +
FREE
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
  
  
Line 26: Line 36:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
  
  
Line 63: Line 79:
 
|-
 
|-
 
|-
 
|-
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" | Object
 
| width="90%" | Object
 
|-
 
|-
Line 86: Line 102:
 
|-
 
|-
 
|-
 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -  
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 104: Line 120:
 
| colspan="2" | e.g. "rss.channel.title" 
 
| colspan="2" | e.g. "rss.channel.title" 
 
|-
 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -  
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 135: Line 151:
 
|-
 
|-
 
|-
 
|-
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" | ParentObject
 
| width="90%" | ParentObject
 
|-
 
|-
Line 150: Line 166:
 
| colspan="2" | data for the object (optional) 
 
| colspan="2" | data for the object (optional) 
 
|-
 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -  
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 168: Line 184:
 
| colspan="2" | e.g. "item.title" 
 
| colspan="2" | e.g. "item.title" 
 
|-
 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -  
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 204: Line 220:
 
|-
 
|-
 
|-
 
|-
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" | Object
 
| width="90%" | Object
 
|-
 
|-
Line 235: Line 251:
 
|-
 
|-
 
|-
 
|-
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" | Object
 
| width="90%" | Object
 
|-
 
|-
 
| colspan="2" | Handle to the object 
 
| colspan="2" | Handle to the object 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BuildXMLString'''
 +
|-
 +
| colspan="2" | Generate a XML string based on the current objects inside the component. 
 +
|-
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
Line 253: Line 282:
 
|-
 
|-
 
|-
 
|-
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" | Object
 
| width="90%" | Object
 
|-
 
|-
 
| colspan="2" | Handle to the object 
 
| colspan="2" | Handle to the object 
 
|-
 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -  
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 275: Line 304:
 
|-
 
|-
 
| colspan="2" | e.g. "item.title" 
 
| colspan="2" | e.g. "item.title" 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BuildJSONString'''
 +
|-
 +
| colspan="2" | Generate a JSON string based on the current objects inside the component. 
 +
|-
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
Line 289: Line 331:
 
|-
 
|-
 
|-
 
|-
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" | Object
 
| width="90%" | Object
 
|-
 
|-
Line 335: Line 377:
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
 
 
|-
 
|-
 
|}
 
|}

Latest revision as of 17:25, 9 November 2022

Author MatrixTSL
Version 1.0
Category Runtime Tools


XML JSON Parser component

A component designed to simplify the collection of data from XML and JSON sources. Parses the raw data and creates a dynamic representation of the data that is easy to navigate and interrogate. Also allows the objects to be manually created or edited and then re-exported as XML or JSON format.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

XML Example

A simple example to read in an XML formatted file and extract data from the structure.

File:XML_Example.zip


A simple example to read a HTML string into the XML parser and extract data from the within the table structure. The HTML string could be provided via a TCP client HTTP GET request.

FC6 Icon.png XML HTML Example


JSON Example

A simple example to read in an JSON formatted file and extract data from the structure.

File:JSON_Example.zip

Downloadable macro reference

Fc9-comp-macro.png SetObjectString
Sets the data string of an existing object. 
Fc9-h32-icon.png - HANDLE Object
Handle to the object 
Fc9-string-icon.png - STRING Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetRootHandle
Allows for user to step through the objects manually using the inbuilt runtime api calls. 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png FindObject
Finds the first instance of an object. Returns the first matching path from the root. Returns 0 if the path was not found. 
Fc9-string-icon.png - STRING ObjPath
e.g. "rss.channel.title" 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png FindObjectString
Searches for and then collects the data string from the specified path. Returns the first matching path from the root. 
Fc9-string-icon.png - STRING ObjPath
e.g. "rss.channel.title" 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png AddObject
Adds a tag at the selected location. Use the GetRootHandle and runtime API Tree functions . Returns the handle of the new object. 
Fc9-h32-icon.png - HANDLE ParentObject
The Object Handle to store the new tag inside 
Fc9-string-icon.png - STRING Tag
Name of the object 
Fc9-string-icon.png - STRING Data
data for the object (optional) 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png FindNextObject
Finds the next instance of an object following a GetObject* call. Returns the first matching path from the last search. Returns 0 if the path was not found. 
Fc9-string-icon.png - STRING SubObjPath
e.g. "item.title" 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png ParseJSONDataString
Parses JSON formatted data in a piecemeal format as and when file data is available. Creates objects to store the contents of the JSON  
Fc9-string-icon.png - STRING Data
JSON Data string, can be a chunk of a file at a time 
Fc9-u16-icon.png - UINT Length
Number of Bytes to process 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetObjectString
Collects the data string from the specified object. 
Fc9-h32-icon.png - HANDLE Object
Handle to the object 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png ClearObjects
Deletes all object data ready for fresh input 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetObjectTag
Collects the tag string from the specified object. 
Fc9-h32-icon.png - HANDLE Object
Handle to the object 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png BuildXMLString
Generate a XML string based on the current objects inside the component. 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png DeleteObject
Deletes a selected tag object. 
Fc9-h32-icon.png - HANDLE Object
Handle to the object 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png FindNextObjectString
Searches for and then collects the data string from the specified path. Returns the first matching path from the last search 
Fc9-string-icon.png - STRING SubObjPath
e.g. "item.title" 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png BuildJSONString
Generate a JSON string based on the current objects inside the component. 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png SetObjectTag
Sets the tag name of an existing object. 
Fc9-h32-icon.png - HANDLE Object
Handle to the object 
Fc9-string-icon.png - STRING Tag
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ParseXMLDataString
Parses XML formatted data in a piecemeal format as and when file data is available. Creates objects to store the contents of the XML. 
Fc9-string-icon.png - STRING Data
XML Data string, can be a chunk of a file at a time 
Fc9-u16-icon.png - UINT Length
Number of bytes to process 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties