Skip to content

contributions.json

This article is a detailed reference guide to the contributions.json-file. It includes a catalog of all supported capabilities and the available options.

The file consists of a JSON object with keys each defining functionality of the app. The keys are listed with headings below.

`menu`

The menu contribution is used to define menus in certain places in Scifeon.

{
    "main": [{
        "text": "string",
        "url": "string",
        "rank?": 0,          // manipulate the position of the item
        "iconFA?": "string", // a FontAwesome icon - fallback to the first letter of the text
        "favorite?": true,   // also show in the sidebar that is always visible
        "items?": [{         // sub items that belongs to the main item
            "text": "string",
            "url": "string",
            "roles?": ["string"]
        }],
        "roles?": ["string"]
    }],
    "admin": [{
        "section?": "string", // group the item in a specific section
        "route": "string",
        "text": "string"
    }],
    "subMenu": [{
        "url": "string",
        "items": [{
            "section": "string",
            "src": "string",
            "url": "string",
            "text": "string"
        }]
    }]
}

`menu.main`

This is reserved for defining menu items for the main menu. The entries in the items-array are shown as sub-items to the main-menu-item defined. The roles-array can be used to define whether the item should only be used to users with certain role(s).

`menu.admin`

This is reserved for defining menu items for the Administration pages.

`menu.{subMenu}`

`database`

{
    "database": {
        "prefix": "string",
        "datamodel": "string",
        "sequences": [{
            "id": "string",
            "prefix": "string",
            "minDigits": "number",
            "type": "string",
            "nextValue?": "number"
        }],
        "views": [{
            "name": string,
            "accessScope": string,
            "sql": string
        }],
    }
}

`database.prefix`

`previewFeatures`

`dashboards`

`userRoles`

`entities`

`files`