Task List Service UI

In order to help you build your own Solution, find below an example of a basic YAML model, serving as a "Hello World" for you to understand the power of our source code generator.

This example model reflects a use case for Task List Registration, which is intended to perform certain registration operations (CRUD) to the database.

Also a simple UI project is included in model definition, once deployed this UI can be used to perform all tasks directly in the browser.

---

YAML Example:

Name: TaskListUI # Solution name
RootNamespace: TaskListUI # Solution root namespace

# Business entities

Entities:
  - Name: Task
    KeyType: Guid
    Properties:
      - Name: Title
        Type: string
      - Name: Description
        Type: string
      - Name: DueDate
        Type: DateTimeOffset
      - Name: TaskType # Relationship with TaskType Entity
        Type: TaskType
      - Name: TaskTypeId
        Type: int
      - Name: TaskStatus # Relationship with TaskStatus Entity
        Type: TaskStatus
      - Name: TaskStatusId
        Type: int
      - Name: CreatedUtc
        Type: DateTimeOffset
      - Name: ModifiedUtc
        Type: DateTimeOffset

  - Name: TaskType
    KeyType: int
    Properties:
    - Name: Name
      Type: string
    - Name: Tasks
      Type: '[Task]'

  - Name: TaskStatus
    KeyType: int
    Properties:
    - Name: Name
      Type: string
    - Name: Tasks
      Type: '[Task]'


# Database instance types

DbInstances:
  - Name: PostgreInstance
    Type: PostgreSql

Databases:
  - Name: TasksDb
    DbInstanceName: PostgreInstance

# Identity Server configuration section

IdentityConfig:
  DatabaseName: TasksDb # The database for Identity Server data storage

# Database data contexts

DbContexts:
  - Name: TasksDbContext
    DatabaseName: TasksDb

# Data access repository pattern

Repositories:
  - Name: TaskRepo
    DbContextName: TasksDbContext
    EntityName: Task

  - Name: TaskTypeRepo
    DbContextName: TasksDbContext
    EntityName: TaskType

  - Name: TaskStatusRepo
    DbContextName: TasksDbContext
    EntityName: TaskStatus

# Validations rules for the business entity

EntityValidations:
  - Name: TaskValidation
    Type: PropertyValidation
    EntityName: Task
    PropertyValidationParams:
    - PropertyName: Title
      Rules: # Pre-defined types that run sequentially
      - Type: IsNotEmpty
        Message: Title is required.

    - PropertyName: DueDate
      Rules:
      - Type: IsNotEmpty
        Message: Due Date is required.

    - PropertyName: TaskTypeId
      Rules:
      - Type: IsNotEmpty
        Message: Type of Task is required.

    - PropertyName: TaskStatusId
      Rules:
      - Type: IsNotEmpty
        Message: Status is required.

  - Name: TaskTypeValidation
    Type: PropertyValidation
    EntityName: TaskType
    PropertyValidationParams:
    - PropertyName: Name
      Rules:
      - Type: IsNotEmpty
        Message: Name is required.

  - Name: TaskStatusValidation
    Type: PropertyValidation
    EntityName: TaskStatus
    PropertyValidationParams:
    - PropertyName: Name
      Rules:
      - Type: IsNotEmpty
        Message: Name is required.

# Services and Controllers (CRUD + Query)

Services:
  - Name: TaskService
    Type: WebAPI
    Controllers:
    - Name: Task
      Type: CRUD
      EntityName: Task
      RepositoryName: TaskRepo
      Contexts:
      - Context: Create
        Validations: # Validations performed only for the "Create" context
        - Name: DataMustBeValid
          Type: EntityValidation
          Order: 1
          ExecValidationName: TaskValidation
        Rules: # Business rules performed only for the "Create" context
        - Name: AddInRepository
          Type: WriteOperationRule # Executes a business rule for persisting data in the database
          Order: 1
      - Context: Update
        Validations:
        - Name: DataMustBeValid
          Type: EntityValidation
          Order: 1
          ExecValidationName: TaskValidation
        Rules:
        - Name: UpdateInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: UpdatePartial
        Rules:
        - Name: UpdateInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: Delete
        Rules:
        - Name: DeleteInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: ReadAll
        Rules:
        - Name: ReadInRepository
          Type: ReadOperationRule # Executes a business rule for reading data from the database
          Order: 1
      - Context: ReadByKey
        Rules:
        - Name: ReadInRepository
          Type: ReadOperationRule
          Order: 1

    - Name: TaskType
      Type: CRUD
      EntityName: TaskType
      RepositoryName: TaskTypeRepo
      Contexts:
      - Context: Create
        Validations:
        - Name: DataMustBeValid
          Type: EntityValidation
          Order: 1
          ExecValidationName: TaskTypeValidation
        Rules:
        - Name: AddInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: Update
        Validations:
        - Name: DataMustBeValid
          Type: EntityValidation
          Order: 1
          ExecValidationName: TaskTypeValidation
        Rules:
        - Name: UpdateInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: UpdatePartial
        Rules:
        - Name: UpdateInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: Delete
        Rules:
        - Name: DeleteInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: ReadAll
        Rules:
        - Name: ReadInRepository
          Type: ReadOperationRule
          Order: 1
      - Context: ReadByKey
        Rules:
        - Name: ReadInRepository
          Type: ReadOperationRule
          Order: 1

    - Name: TaskStatus
      Type: CRUD
      EntityName: TaskStatus
      RepositoryName: TaskStatusRepo
      Contexts:
      - Context: Create
        Validations:
        - Name: DataMustBeValid
          Type: EntityValidation
          Order: 1
          ExecValidationName: TaskStatusValidation
        Rules:
        - Name: AddInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: Update
        Validations:
        - Name: DataMustBeValid
          Type: EntityValidation
          Order: 1
          ExecValidationName: TaskStatusValidation
        Rules:
        - Name: UpdateInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: UpdatePartial
        Rules:
        - Name: UpdateInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: Delete
        Rules:
        - Name: DeleteInRepository
          Type: WriteOperationRule
          Order: 1
      - Context: ReadAll
        Rules:
        - Name: ReadInRepository
          Type: ReadOperationRule
          Order: 1
      - Context: ReadByKey
        Rules:
        - Name: ReadInRepository
          Type: ReadOperationRule
          Order: 1


    # Required Query Controller to perform UI operations such as filter, sorting...
    - Name: QueryTask
      Type: QUERY
      RepositoryName: TaskRepo
      EntityName: Task

    - Name: QueryTaskType
      Type: QUERY
      RepositoryName: TaskTypeRepo
      EntityName: TaskType

    - Name: QueryTaskStatus
      Type: QUERY
      RepositoryName: TaskStatusRepo
      EntityName: TaskStatus


UIs:
  - Name: TaskListUI # UI project (used for Angular Project + BFF)
    Route: tasklist
    Menus:
    - Path: tasks
      Label: Task
      Description: Task Register
      UiStructure: task
      RouteGroups:
      - Type: List
        Roles: ['admin','users']
        Label: Query tasks
      - Type: Edit
        Roles: ['admin','users']
        Label: Task

    - Path: type
      Label: TaskType
      Description: Task Type Register
      UiStructure: taskType
      RouteGroups:
      - Type: List
        Roles: ['admin','users']
        Label: Query task types
      - Type: Edit
        Roles: ['admin','users']
        Label: Task type

    - Path: status
      Label: TaskStatus
      Description: Task Status Register
      UiStructure: taskStatus
      RouteGroups:
      - Type: List
        Roles: ['admin','users']
        Label: Query task status
      - Type: Edit
        Roles: ['admin','users']
        Label: Task status

    - Path: kpi1
      Label: Task Kpi 1
      Description: Task Kpi 1 - Indicator
      UiStructure: taskKpi1
      RouteGroups:
      - Type: Index
        Roles: ['admin','users']
        Label: Tasks by type and status indicator

    - Path: kpi2
      Label: Task Kpi 2
      Description: Task Kpi 2 - Indicator
      UiStructure: taskKpi2
      RouteGroups:
      - Type: Index
        Roles: ['admin','users']
        Label: Tasks by status indicator

    - Path: kpi3
      Label: Task Kpi 3
      Description: Task Kpi 3 - Indicator
      UiStructure: taskKpi3
      RouteGroups:
      - Type: Index
        Roles: ['admin','users']
        Label: Total tasks indicator

    - Path: kpi4
      Label: Task Kpi 4
      Description: Task Kpi 4 - Indicator
      UiStructure: taskKpi4
      RouteGroups:
      - Type: Index
        Roles: ['admin','users']
        Label: Tasks by type indicator

    - Path: kpi5
      Label: Task Kpi 5
      Description: Task Kpi 5 - Indicator
      UiStructure: taskKpi5
      RouteGroups:
      - Type: Index
        Roles: ['admin','users']
        Label: Tasks by status indicator

    - Path: dash
      Label: Tasks Dashboard
      Description: Tasks Main Dashboard
      UiStructure: mainDashboard
      RouteGroups:
      - Type: Index
        Roles: ['admin','users']
        Label: Tasks Main Dashboard

UIStructures:
  # CRUD Structures
    - Name: task # Set of components to perform Task Crud
      Entity: Task
      Type: Crud
      Service: Task

      CrudParams:

        Controls:
          - Property: Title
            Label: Title
            Hint: 'Inform task title'
            Type: text
            Placeholder: Task title
          - Property: Description
            Label: Desc.
            Hint: 'Inform task description'
            Type: multiline
          - Property: DueDate
            Label: Due Date
            Hint: 'Inform task due date'
            Type: date
          - Property: 'TaskTypeId'
            Label: 'Type of Task'
            Type: combo
            Source: TaskType
            ValueField: Id
            LabelFields: ['Name']
          - Property: 'TaskStatusId'
            Label: 'Status'
            Type: combo
            Source: TaskStatus
            ValueField: Id
            LabelFields: ['Name']

        Filter:
          FormControls: ['Title']
          SubmitButtonLabel: Search
          SubmitButtonStyle: basic

        Grid:
          QueryOrderFields:
          - Property: Title
            Type: asc
          QueryRegistersLimit: 100
          PageSizes: [5, 10 , 20]
          Fields:
            - Property: Title
            - Property: TaskType.Name
              Title: Type
            - Property: TaskStatus.Name
              Title: Status

        EditForm:
          FormControls: ['Title', 'Description', 'DueDate', 'TaskStatusId', 'TaskTypeId']
          Validations: ['TaskValidation']
          SubmitButtonLabel: 'Save'
          SubmitButtonStyle: primary

    - Name: taskType # Set of components to perform TaskType Crud
      Entity: TaskType
      Type: Crud
      Service: TaskType

      CrudParams:

        Controls:
          - Property: Name
            Label: Name
            Hint: 'Inform task type'
            Type: text

        Filter:
          FormControls: ['Name']
          SubmitButtonLabel: Search
          SubmitButtonStyle: basic

        Grid:
          QueryOrderFields:
          - Property: Name
            Type: asc
          QueryRegistersLimit: 100
          PageSizes: [5, 10 , 20]
          Fields:
            - Property: Name

        EditForm:
          FormControls: ['Name']
          Validations: ['TaskTypeValidation']
          SubmitButtonLabel: 'Save'
          SubmitButtonStyle: primary

    - Name: taskStatus # Set of components to perform TaskStatus Crud
      Entity: TaskStatus
      Type: Crud
      Service: TaskStatus

      CrudParams:

        Controls:
          - Property: Name
            Label: Name
            Hint: 'Inform task status'
            Type: text

        Filter:
          FormControls: ['Name']
          SubmitButtonLabel: Search
          SubmitButtonStyle: basic

        Grid:
          QueryOrderFields:
          - Property: Name
            Type: asc
          QueryRegistersLimit: 100
          PageSizes: [5, 10 , 20]
          Fields:
            - Property: Name

        EditForm:
          FormControls: ['Name']
          Validations: ['TaskStatusValidation']
          SubmitButtonLabel: 'Save'
          SubmitButtonStyle: primary

  # CHART Structures

    - Name: taskKpi1
      Entity: Task
      Type: Chart
      Service: Task
      ChartParams:
        Title: Task Kpi 1
        Description: Tasks by type and status
        AxisAggregatePropertyName: TaskTypeId
        AxisAggregatePropertyLabel: TaskType.Name
        Series:
        - PropertyName: Id
          Operator: Count
          Label: Total
          Type: bar
          AggregatePropertyName: TaskStatusId
          AggregatePropertyLabel: TaskStatus.Name

    - Name: taskKpi2
      Entity: Task
      Type: Chart
      Service: Task
      ChartParams:
        Title: Task Kpi 2
        Description: Tasks by status
        Series:
        - PropertyName: Id
          Operator: Count
          Label: Total
          Type: donut
          AggregatePropertyName: TaskStatusId
          AggregatePropertyLabel: TaskStatus.Name

    - Name: taskKpi3
      Entity: Task
      Type: Chart
      Service: Task
      ChartParams:
        Title: Task Kpi 3
        Description: Tasks Total
        Series:
        - PropertyName: Id
          Operator: Count
          Label: Total
          Type: radialBar

    - Name: taskKpi4
      Entity: Task
      Type: Chart
      Service: Task
      ChartParams:
        Title: Task Kpi 4
        Description: Tasks By Type Total
        AxisAggregatePropertyName: TaskTypeId
        AxisAggregatePropertyLabel: TaskType.Name
        RenderAsSpark: true
        Series:
        - PropertyName: Id
          Operator: Count
          Label: Total
          Type: area

    - Name: taskKpi5
      Entity: Task
      Type: Chart
      Service: Task
      ChartParams:
        Title: Task Kpi 5
        Description: Tasks By Status Total
        AxisAggregatePropertyName: TaskStatusId
        AxisAggregatePropertyLabel: TaskStatus.Name
        Series:
        - PropertyName: Id
          Operator: Count
          Label: Total
          Type: line

    - Name: taskKpi6
      Entity: Task
      Type: Chart
      Service: Task
      ChartParams:
        Title: Task Kpi 6
        Description: Tasks By Status Total
        AxisAggregatePropertyName: TaskStatusId
        AxisAggregatePropertyLabel: TaskStatus.Name
        RenderAsSpark: true
        Series:
        - PropertyName: Id
          Operator: Count
          Label: Total
          Type: area


  # DASHBOARD Structures

    - Name: mainDashboard
      Entity: Task
      Type: Dashboard
      Service: Task

      DashboardParams:
        Title: Tasks Main Dashboard
        Kpis: [taskKpi1, taskKpi2, taskKpi3, taskKpi4, taskKpi5, taskKpi6]

UIServices:
  - Name: Task # Service which will be used to perform UI operations
    Entity: Task
    CrudService: TaskService
    CrudController: Task
    QueryService: TaskService
    QueryController: QueryTask

  - Name: TaskType
    Entity: TaskType
    CrudService: TaskService
    CrudController: TaskType
    QueryService: TaskService
    QueryController: QueryTaskType

  - Name: TaskStatus
    Entity: TaskStatus
    CrudService: TaskService
    CrudController: TaskStatus
    QueryService: TaskService
    QueryController: QueryTaskStatus

---

OData Example

...

  - Name: QueryTask
    Type: QUERY
    RepositoryName: TaskRepo
    EntityName: Task

...

Filter Request Example

https://loadbalancer.bea.internal:44300/taskservice/odata/QueryTaskQuery?$filter=Title eq 'Task 02'

Response Example

{
    "@odata.context": "https://loadbalancer.bea.internal:44300/taskservice/odata/$metadata#QueryTaskQuery",
    "value": [
        {
            "Id": "20048b5b-ff49-4039-b82a-fd6281d83bfb",
            "Title": "Task 02",
            "Description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "DueDate": "2020-12-31T00:00:00Z",
            "Status": 1
        },
        {
            "Id": "f5448d16-4e75-4d3c-9f4b-00cfbd654815",
            "Title": "Task 02",
            "Description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "DueDate": "2020-12-31T00:00:00Z",
            "Status": 1
        }
    ]
}

Order By Request Example

https://loadbalancer.bea.internal:44300/taskservice/odata/QueryTaskQuery?$orderby=Title desc

Response Example

{
    "@odata.context": "https://loadbalancer.bea.internal:44300/taskservice/odata/$metadata#QueryTaskQuery",
    "value": [
        {
            "Id": "3a9f0563-d4ca-4931-881e-194d6e6b2f0e",
            "Title": "Task 03",
            "Description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "DueDate": "2020-12-31T00:00:00Z",
            "Status": 1
        },
        {
            "Id": "20048b5b-ff49-4039-b82a-fd6281d83bfb",
            "Title": "Task 02",
            "Description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "DueDate": "2020-12-31T00:00:00Z",
            "Status": 1
        },
        {
            "Id": "f5448d16-4e75-4d3c-9f4b-00cfbd654815",
            "Title": "Task 02",
            "Description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "DueDate": "2020-12-31T00:00:00Z",
            "Status": 1
        },
        {
            "Id": "33dd9a85-5382-4b77-a451-cc44474f5bf1",
            "Title": "Task 01",
            "Description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "DueDate": "2020-12-31T00:00:00Z",
            "Status": 1
        }
    ]
}

---