ToJson method

Returns a string with the JSON representation for the Structured Data Type (SDT) object or Business Component variable. 

Syntax

&String = &var.ToJson([&Boolean])

Where:
&String
    Attribute or variable based on the Character data type.

&var
    Variable based on an SDT or Business Component.

&Boolean
     Optional parameter. It only applies to Business Component variables. If True, the returned string contains the auxiliary variables (old values, mode, initialized flag). Otherwise, it only contains the record data. The default value is True.

Scope

Generators: .NET, .NET Framework, Java

Samples

1) Given the following SDT:

Define a Data Provider object (for example, named DPOneCountry). Drag the Country SDT from the KB Explorer to the Data Provider Source and fill in the data as shown below:

Country
{
    Name = "Uruguay"
    Language = "Spanish"
    Coordinates
    {
        Latitude = 30
        Longitude = 35
    }
    Cities
    {
        Item
        {
            Item = "Montevideo"
        }
        Item
        {
            Item = "Paysandu"
        }
    }
}

In a Web Panel object, define a variable named &Country based on the Country SDT.

The purpose of the Web Panel is to convert data from a variable based on an SDT to a Json format. To achieve this, when the end user presses a button, the Event associated with it will load into memory (in the &Country variable) data of one country using the DPOneCountry Data Provider. After that, the Json method will be applied to the &Country variable to convert the data to a Json format. Finally, it will be displayed in the Web Panel Web Layout.

Design the Web Panel Web Layout as shown below:

Define the following code associated with the Web Panel button:

Event 'ToJson'
   &SDTCountry = DPOneCountry()
   &Json=&SDTCountry.ToJson()
Endevent

The variables involved are as follows:

&Json                  Type: Character(200)
&Country               Type: Country

At runtime, when the end user presses the button, the country data is loaded in the &Country variable and converted to Json format. The &Json variable will contain and show the following:

{"Name":"Uruguay","Language":"Spanish","Coordinates":{"Latitude":30,"Longitude":35},"Cities":{{"Item":"Montevideo"},{"Item":"Paysandu"}}}

2) It is possible to apply the ToJson method to a variable based on an SDT that contains a member based on the GeoPoint data type and it will be represented as plain text (serialized) using the Well KnownText standard (WKT).

Consider a Structured Data Type defined as follows:

SDT1
{
     CharacterMember: Character
     GeoPointMember: GeoPoint
 }

Initialize a variable based on the Structured Data Type and, after that, define the following code (for example in a Procedure Source or in a Web Panel / Panel Event):

 &VarBasedOnSDT1.ToJson()

The result will be something as follows:

 [{"CharacterMember":"","GeoPointMember":"POINT(-56.10 -33.01)"}]

See Also

FromJson method