Command Results JSON

After Archy finishes running a command, it can output a JSON file that contains details about the command that was run. You can enable this on most commands with the --resultsFile command line parameter. If you specify just an output file name with a .json extension, it will be created in a results directory inside of your archyHome directory. If you specify a fully-qualified file path, Archy will attempt to write the file to that file path. If the directory structure to the fully qualified file path does not exist, Archy will attempt to create the directory structure that contains the file. If a file name or path is not specified, an error will be thrown, and the results output will not be created. Additionally, if you specify a filename with a .json extension and that file already exists, you can use the --overwriteResultsFile argument to overwrite that file.

This will then create a JSON output like the example below:

{
    "version": "2.33.1",
    "command": "create",
    "status": "success",
    "exitCode": 0,
    "settings": {
        "debug": {
            "value": true,
            "source": "command line parameter"
        },
        "filePath": {
            "value": "/path/to/myFlow.yaml",
            "source": "command line parameter"
        },
        "homeDir": {
            "value": "/path/to/homeDir",
            "source": "options file"
        },
        "location": {
            "value": "mypurecloud.com",
            "source": "options file"
        },
        "optionsFile": {
            "value": "/path/to/optionsFile.yaml",
            "source": "command line parameter"
        },
        "recreate": {
            "value": true,
            "source": "command line parameter"
        }
    },
    "output": {
        "traces": [
            {
                "text": "Error traces can appear here in real Archy output.",
                "type": "error",
                "dateTime": "2020-05-15T12:30:53.806Z"
            },
            {
                "text": "Warning traces can appear here in real Archy output.",
                "type": "warning",
                "dateTime": "2020-05-15T12:31:48.782Z"
            }
        ],
        "debugFilePath": "/path/to/debugFile.txt",
        "flowName": "Flow name from myFlow.yaml above"
    },
    "startDateTime": "2020-05-15T16:35:17.603Z",
    "endDateTime": "2020-05-15T16:35:33.614Z"
}

JSON Schemas for Archy's JSON output files can be found in your archyHome directory under schemas/definitions/commandResultsSchema.

More information on what properties are expected for each of the different Archy commands can be found in the appendices section for the command results schemas.

Archy - Ver. 2.33.1, generated on January 3, 2025

Command Results JSON

Privacy Settings