Overview
JSON is the structured file format this connector handles: nested objects and arrays rather than the flat rows of a CSV. In an enterprise estate JSON files usually arrive as API responses that someone has captured and saved, as exports from cloud consoles and developer tooling, or as configuration and licence manifests from vendor products. The format carries hierarchy, which means one file can hold an entire object graph where a CSV would need several.
The connector reads those files and writes them to staging tables. The json_file.php driver walks the document and flattens it: a job’s Data Node tells it which node to descend to before building rows, so a payload wrapped in an envelope such as result.items yields one row per item instead of one row for the envelope. Nested arrays below that point become their own related tables. Files are read either from a directory on the ReadyWorks server, including files uploaded through the console, or pulled from an FTP server.
In a ReadyWorks context this is the route for structured extracts that no API connector covers, and for one-off captures taken from systems ReadyWorks is not permitted to call directly. Once flattened, the staged tables join to device, identity and application data on whatever natural key the payload carries.
The connector is inbound only. It reads files and writes staging tables, and it never writes JSON back out.
NOTE: Data Node is the setting that makes or breaks a JSON job. Left blank, the parser starts at the document root, which for an enveloped payload produces a single row. Set it to the path of the array you actually want.
Connector Properties
Authentication Methods
Two methods ship. Both use the same parsing driver and differ only in where the file comes from.
Method 1: JSON File (JSON_file)
No Authentication
JSON File reads from a directory on the ReadyWorks server. Set Server File Path to that directory (the default is storage/etl5), and set Manual File Upload to Yes when operators will attach files through the console. Process Unchanged Files controls whether re-reading an unchanged file is treated as an error.
Connection Configuration Fields (3)
No authentication recipe is stored. The driver script authenticates natively using the fields above.
Method 2: FTP Server (JSON_ftp)
Download JSON files from an FTP server
FTP Server downloads files from an FTP host before parsing them. Supply the server name and port (the default is 21), and a temporary working path on the ReadyWorks server where downloaded files are held during processing. Username and Password are optional, which allows anonymous FTP.
Connection Configuration Fields (5)
No authentication recipe is stored. The driver script authenticates natively using the fields above.
NOTE: The form has no option for FTPS or SFTP, and no certificate settings. Plain FTP carries credentials and file contents without encryption, so keep the transfer inside a trusted network segment.
NOTE: The Password field’s help text reads “Enter username of the FTP connection”. Enter the password.
Inbound Job Fields Enabled (11)
These are the job-level settings exposed for a JSON import. Data Node is the JSON-specific one.
Inbound Job Templates (1)
One inbound template ships as a worked example. It arrives disabled and points at a placeholder file name, so it is a starting point to copy rather than a job to enable.
Job Template Configuration
Settings
Job Parameters and Enumeration
JSON File
JSON File or Path: your_json_file.json
Outbound Job Templates (0)
This connector ships no outbound templates and does not support outbound jobs.