- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This shows you the differences between two versions of the page.
|
expression function - json to field [2016/09/14 18:19] |
expression function - json to field [2016/09/14 18:19] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== JSON_TO_FIELD (Expression Function) ====== | ||
| + | ===== Purpose ===== | ||
| + | The **JSON to Field** function (JSON_TO_FIELD) takes the input of a JSON encoded string and converts it to a field value. | ||
| + | |||
| + | {{::json_to_field.png?direct&600|}} | ||
| + | ===== Parameters ===== | ||
| + | The **JSON to Field** function has two input parameters: | ||
| + | |||
| + | ==== Field Value ==== | ||
| + | |||
| + | Allowed Inputs: [[Field|field]] value | ||
| + | |||
| + | The builder can enter one string that is JSON encoded. The builder should use the [[Query Builder]] to choose a field that contains a value. | ||
| + | |||
| + | ==== Multiple Value Field ==== | ||
| + | |||
| + | Allowed Inputs: 'yes' or 'no' | ||
| + | |||
| + | If Multiple Value Field is set to yes it will tell the function to convert an array of objects into multiple field values that can be stored in a field that has the multiple value option turned on | ||
| + | |||
| + | ===== Output ===== | ||
| + | |||
| + | The output of the **JSON to Field** function is a WorkXpress field storage value comprised of the value(s) from the JSON Encoded String. For multiple part fields such as [[Field Type - Address|address]], [[Field Type - Telephone|telephone]], or [[Field Type - Multiple Part|multiple part]] the JSON should be a string with the proper labels. For example an address might look like {"street": "123 Main St","city": "Small Town","state": "PA","zip": "17000"}. | ||
| + | |||
| + | ===== Example ===== | ||
| + | |||
| + | This function is most commonly used when communicating with a third party system that can send values that are JSON encoded. | ||
