Modifying Report Templates

How does the report system work?

Coord Reports are generated using a service provided by Carbone.io. When you run a report on SoundBase, it sends a JSON object with the Project’s info to the Carbone.io API which renders the selected template.

Templates

To generate a custom report, you must first create a template. You can download and modify our default DOCX template from the Zone Generate Report Dialog and upload your changes to a new template within that dialog.

User uploaded templates are stored PER USER, not per project. This means you can use the same template across multiple projects.

Changing a template

The documentation for the Carbone template language can be found here: https://carbone.io/documentation.html#building-a-template

If you want to change anything deep inside the templates, for example the way groups are shown, etc., then it is helpful to know the JSON data that is sent to Carbone. You can see an example of that structure here:

JSON Structure

json
{
    "createdDate": "12/21/2023 19:08:04",
    "now": "2023-12-22T00:08:04.351Z",
    "zoneName": "Default Zone",
    "siteName": "Site #1",
    "project": {
        "projectName": "Touring example",
        "locationName": "",
        "startDate": "",
        "endDate": "",
        "notes": "",
        "owner": ""
    },
    "client": {
        "name": "",
        "contactName": "",
        "email": "",
        "contactPhone": "",
        "notes": ""
    },
    "coordinator": {},
    "groups": [
        {
            "groupName": "AD2 (1 Freq)",
            "groupId": "QXz2XGtfGGNSKBj5s",
            "color": "#319795",
            "freqs": [
                {
                    "freqName": "HH 1",
                    "model": "AD4Q-A",
                    "band": "G57",
                    "manufacturer": "Shure",
                    "freq": "480.300",
                    "spacing": "25.725",
                    "preset": "",
                    "isIncompatible": false,
                    "color": "black",
                    "profileVariant": "High Density"
                }
            ],
            "freqCount": 1
        },
        {
            "groupName": "IEM's (1 Freq)",
            "groupId": "HzbcFjSu6KGDLhhaj",
            "color": "#f44e3b",
            "freqs": [
                {
                    "freqName": "IEM 1",
                    "model": "PSM1000",
                    "band": "H22",
                    "manufacturer": "Shure",
                    "freq": "561.450",
                    "spacing": "0.700",
                    "preset": "",
                    "isIncompatible": false,
                    "color": "black",
                    "profileVariant": "Standard"
                }
            ],
            "freqCount": 1
        }
    ],
    "tvchannels": [
        {
            "channel": "9",
            "range": "186 - 192 MHz",
            "callSign": "WTVI",
            "distance": 9.24,
            "power": 3.2,
            "type": "Digital"
        },
        {
            "channel": "14",
            "range": "470 - 476 MHz",
            "callSign": "WHKY-TV",
            "distance": 9.24,
            "power": 260,
            "type": "Digital"
        },
        {
            "channel": "18",
            "range": "494 - 500 MHz",
            "callSign": "WCCB",
            "distance": 6.65,
            "power": 963,
            "type": "Digital"
        },
        {
            "channel": "19",
            "range": "500 - 506 MHz",
            "callSign": "WSOC-TV",
            "distance": 6.9,
            "power": 1000,
            "type": "Digital"
        },
        {
            "channel": "21",
            "range": "512 - 518 MHz",
            "callSign": "WUNG-TV",
            "distance": 15.91,
            "power": 260,
            "type": "Digital"
        },
        {
            "channel": "32",
            "range": "578 - 584 MHz",
            "callSign": "WAXN-TV",
            "distance": 6.9,
            "power": 200,
            "type": "Digital"
        },
        {
            "channel": "37",
            "range": "608 - 614 MHz",
            "callSign": "",
            "distance": "",
            "power": "",
            "type": "Digital"
        }
    ],
    "tvChannelCount": 7,
    "freqs": [
        {
            "freqName": "HH 1",
            "model": "AD4Q-A",
            "band": "G57",
            "manufacturer": "Shure",
            "freq": "480.300",
            "spacing": "0.510",
            "preset": "",
            "isIncompatible": false,
            "color": "black",
            "zoneName": "Default Zone",
            "siteName": "Site #1",
            "profileVariant": "High Density"
        },
        {
            "freqName": "IEM 1",
            "model": "PSM1000",
            "band": "H22",
            "manufacturer": "Shure",
            "freq": "561.450",
            "spacing": "0.700",
            "preset": "",
            "isIncompatible": false,
            "color": "black",
            "zoneName": "Default Zone",
            "siteName": "Site #1",
            "profileVariant": "Standard"
        }
    ]
}