app.yml

App File

An app file determines the root of an Smartmate app. It contains the application definition and settings.

type

object

properties

  • id

It should be unique in the workspace. It should start with a letter and can contain only letters and numbers. Cannot be ‘public’ or ‘common’.

type

string

examples

customerService

recruitment

maxLength

40

minLength

2

pattern

^(?!([p|P][u|U][b|B][l|L][i|I][c|C]$))(?!([c|C][o|O][m|M][m|M][o|O][n|N]$))[a-zA-Z][a-zA-Z0-9]+$

  • type

File type. It must be ‘app’.

type

string

enum

app

default

app

  • name

App name

Name

  • description

Description of the app

type

string

  • icon

App icon. Smartmate uses font awesome icons. See https://fontawesome.com/icons?d=gallery&s=solid&m=free for a list of icons you can use.

examples

address-book

server

Icon

  • color

App color

examples

#193152

#CCC

Color

  • active

Whether the app is active or not.

type

boolean

default

True

  • menuItems

DEPRECATED in favor of items

https://schemas.apps.smartmate.io/apps/menu/menu.schema.json

  • roles

App roles defined for this app.

roles

  • items

Items to be displayed in the menu of the app.

type

array

items

item

additionalProperties

False

Examples

# myApp.yml

id: recruitment
type: app
name: Recruitment
icon: address-card
color: '#F5FFFA'
active: true

roles:
  recruiter:
    name: Recruiter
    description: Allows the user to perform any operation in this app
  interviewer:
    name: Interviewer
    description: Allows to see only the information of the candidates they are interviewing.

items:
  - title: Catalogs
    items:
      - title: Countries
        table: countries
        sortBy:
          - name: asc
      - title: Currencies
        table: currencies
        sortBy:
          - name: asc
  - title: Purchase Requests
    table: purchaseRequests
    columns:
      - date
      - requester
      - description
      - status
    sortBy:
      - date: desc
    items:
      - title: New
        filter:
          rules:
            - field: status
              operator: =
              value: new
      - title: Approved
        filter:
          rules:
            - field: status
              operator: =
              value: approved
      - title: Rejected
        filter:
          rules:
            - field: status
              operator: =
              value: rejected

See: