Skip to content

App Structures

JSON properties available:

  • name
  • themeColor
  • dateFormat
  • timeFormat
  • timezone
  • loginBackgroundImage
  • companyLogo
  • favicon
  • instanceIcon
  • apps
  • cronJobs
  • mqHandlers
  • allowedAccountsForNonProdEmailSending

Example

{
  "name": "Project Name",
  "themeColor": "#243746",
  "dateFormat": "dd/MM/yyyy",
  "timeFormat": "h:mm a",
  "timezone": "Australia/Sydney",
  "loginBackgroundImage": "https://...backgroundImage.png",
  "companyLogo": "https://...companyLogo.png",
  "favicon": "https://...favicon.ico",
  "instanceIcon": "https://...instanceIcon.png",
  "apps": [
    {
      "key": "shipping",
      "icon": "fas fa-ship",
      "name": "Shipping",
      "dashboard": {
        "name": "Shipping"
      },
      "menu": [
        {
          "key": "shipments",
          "label": "Shipments",
          "entityKey": "shipment"
        },
        {
          "key": "shipping_setup",
          "label": "Shipping Setup",
          "item_groups": [
            {
              "key": "shipping_setup",
              "items": [
                {
                  "key": "address",
                  "entityKey": "address",
                  "label": "Addresses"
                },
                {
                  "key": "address_types",
                  "entityKey": "address_type",
                  "label": "Address Types"
                }
              ]
            }
          ]
        },
        {
          "key": "shipping_organisations",
          "label": "Shipping Organisations",
          "item_groups": [
            {
              "key": "shipping_organisation",
              "items": [
                {
                  "key": "organisations",
                  "entityKey": "organisation",
                  "label": "Organisations"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "cronJobs": [
    { "command": "example-cron-job", "cronTime": "*/20 * * * * *" },
    { "command": "example-cron-job", "cronTime": "*/30 * * * * *" }
  ],
  "mqHandlers": [
    { "command": "example-custom-handler1" },
    { "command": "example-custom-handler2" },
  ],
  "allowedAccountsForNonProdEmailSending": [
    "april9.com.au",
    "user.test@april9.com.au",
  ]
}