This topic covers previous (pre-9.7) implementations of the JSON Data Bank, which extracts content from JSON for tool parameterization. The previous implementations are deprecated: any existing tools will continue to work, but all new JSON Data Banks you add will use the new implementation.
For details on the current tool implementation, see JSON Data Bank.
Sections discussing the deprecated tool include:
Understanding JSON Data Bank
When the message sent by the server is a JSON object, you may want to extract property values from that object and use those values in another tool. The JSON Data Bank gives you a way to easily visualize the structure of the JSON object and select the properties they wish to store for later use.
Configuring the JSON Data Bank
To configure the JSON Data Bank, complete the following:
Right-click the that will be receiving a JSON object and select Add Output.
- In the Add Output wizard that displays, select Response> Traffic then choose JSON Data Bank from the All Tools list, and click the Finish button. A Response Traffic> JSON Data Bank node displays beneath the selected Messaging Client.
- Double-click the Response Traffic> JSON Data Bank node. When you first chain the JSON Data Bank, there will be no JSON object stored within the tool. To initialize it with a JSON object, you can either select to the Literal tab and paste in the JSON text, or you can run your tool and the response object will automatically show up in the Expected JSON area.
- Once the JSON Data Bank holds a JSON object, you can go to the JSON tab in the Expected JSON panel and select any portion of the object. Once selected, you can click on the Add button in the center to extract the value during runtime. The keyword "this" in the JSON tab represents the object itself.
The extracted properties will display in the right-hand table. When you double-click on the entry or click Modify, a dialog will display that allows for more extraction options.
- Extraction: Allows you to select a different property to extract.
- Data Source column name: Allows you to change the column name that this value will be mapped to. You can also choose to write the value to a Writable Data Source or variable.
Once you have everything set up in the JSON Data Bank, you can use the extracted value by switching a parameterizable field to Parameterized mode and selecting the column you want.