Working with JSON to File Process
Process Purpose
The "JSON to File" process is used to parse information from a JSON source file and store the results into a Data File.
You can parse up to 40 fields in one single command.
When you add a process, you are required to define its settings. This occurs in the process's properties window which is displayed automatically after having added the "JSON to File" process.
If any subsequent edition is required, double-click the process to open its properties window and enter the necessary modifications.
Fill in the following options:
JSON Source |
|
Content Type |
Define the type of content to be read in the JSON source: String - If you check this option, click File - If you check this option, enter the "Path + File Name" OR click |
File to Update |
|
Local File Name |
Select the data file that receives the data from the drop-down. If necessary, click |
Select root element of array |
Select the root element to parse data from, from the drop-down. |
Field column |
Select the data file's field that receives the data from the drop-down. |
JSON Sub Path Name column |
Select the information from the drop-down OR click |
If...Go to |
|
JSON Error |
Select a target location from the drop-down or
|
Write Error |
Select a target location from the drop-down or
|
Use the editing icons to the right of the table to move the rows up and down and to delete or add more rows.
You can use relative paths to refer the required file(s). See Working with Aliases.
Detail of a window:
"S:Menu" is a screen included in the same program as the process.
"R:Routine_1" is a routine included in the same program as the process.
If required, use the icons on the upper right corner of the properties window:
Click this icon to define a JSON Data Source. It opens a "Select JSON Data Source" window. For more information on how to fill the options available, see Detail of a "Select JSON Data Source" window below.
Click this icon to create a new data file. Go to Creating a Data File to see how to fill in the several options available.
Use the icon to attach any relevant notes to this process. Click it and enter your notes in the resulting text box. These notes will be displayed in the corresponding "Actions" tab or "Process" window (in the "Notes" field) and in the "Developer Report".
After filling in the required options, click to conclude or click
to abort the operation.
The added process is displayed in the corresponding "Actions" tab or "Process" window.
Detail of a "Select JSON Data Source" window
After clicking , you open the "Select JSON Data Source" window.
Fill in the following options
JSON Data Source |
|
JSON Data Source |
Select the data source (URL or File): Load from URL - Enter the required URL and click Load from File - Enter the "path+file name" OR click |
JSON Content |
|
If the selected data source is a file, the table provides a view of the data contained in that JSON file. |
|
JSON Structure |
|
If the selected data source is a file, you are provided with a view of its structure. |
|
Once you have selected the JSON Data Source, click to conclude or
to abort the operation.
You can use relative paths to refer the required file(s). See Working with Aliases.
If you want to use a label as a target destination, you can use the "Auto-Label" mechanism. This alternative to the "Set Label" process allows you to create a label in the properties window of a process - specifically, in the fields used to define target destinations (ex: the "If Error..." type fields). See To Automatically Create a Label.
Use the right-click in MCL-Designer's input boxes to access some related options as well as the general "Cut", "Copy"; "Paste"; "Search" actions (active/inactive according to the current context).
Ex: If you right-click the "Variable" input box (included in a "Conversion's" properties window), you are provided with general editing/search actions and other more specific options such as "Variable Select" (see "Variable Select"); "Variable Insert" (see "Variable Insert"); "Insert Special Character" (see To Insert Special Characters into a Control's Text Input Field) and "Localization Select" (see Localization List).
If you right-click another input box, it may provide other possibilities.