Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Handling JSON data in PhixFlow often requires adding escape characters or removing characters that PhixFlow cannot recognise.

Tip

Some databases do not recognise 4-bit characters, such as emojis; see Database for recommended database configurations. 

  • Oracle database with the recommended configuration can store the full range of Unicode characters including 4-bit characters.
  • MariaDB  databases cannot store 4-bit characters. You will need to remove any invalid characters before writing to the database

Escaping Invalid Characters

If you are outputting stream data into JSON format, the data can include special characters that JSON will not accept. The following macro escapes these invalid characters. 

Code Block
titleMacro
do(
    $value = $args[1],
    $value = replaceAll( $value , "\b","\\\\b"),
    $value = replaceAll( $value , "\f","\\\\f"),
    $value = replaceAll( $value , "\t","\\\\t"),
    $value = replaceAll( $value , "\r","\\\\r"),
    $value = replaceAll( $value , "\n","\\\\n"),
    $value = replaceAll( $value , "\\\\","\\\\\\\\"),
    $value = replaceAll( $value , '"','\\\\"')
)

Validating Data Imported Into PhixFlow

JSON data, like any imported data format, can include characters that cannot be written to a database that is using the UTF-8 character set. For example, 4-bit Emojis are not supported by UTF-8.

...

Insert excerpt
_Banners
_Banners
namephixScript
nopaneltrue

4-byte Characters in Different Databases

PhixFlow stores its data in a database. The recommended database configurations, described on the database pages in Infrastructure Planning and Delivery, mean your instance of PhixFlow can store UTF8 characters in its database. However, the different databases handle 4-byte characters (such as emojis) differently. 

DatabaseBehavior
OracleStores 4-byte characters correctly.
SQL ServerDiscards or converts 4-byte characters.
MariaDB

Fails to store 4-byte characters because it only recognises a sub-set of UTF8 (UTF8mb3/UTF8mb4).

If you are loading data from another database, a file or emails, you will need to either escape or remove any invalid characters before writing to PhixFlow running on MariaDB.

For information about how to escape characters, see Text Expressions and Escape Characters.

Removing Characters

The following regex lists the characters expected in a JSON file and removes invalid characters from it. You could adapt this regex to validate the data that you want to load into PhixFlow.

Code Block
titleValidating Characters
replaceAll(JSON Code,"[^\\p{Space}0-9A-Za-z!:\\\"%&\\[*()\\],-/_\\\\{}\\.]","")

...

For information about how this line uses escape characters, see Regular Expressions.

An alternative expression for matching characters that are valid in MariaDB is:

Code Block
[^\u0000-\u0FFF]


...