UIServices

With the 'UIServices' section you will be able to create service artifacts at front-end layer which orchestrate operations with backend through http requests.

These service artifacts are included in a specific library with the intent to provide a simple way to reuse across the front-end layer.

Fields

A uiservice contains the following fields to be defined:

Name

The name of uiservice class to be created at front-end layer.

Requirements Rules:

• Is Required;
• Must not be a Reserved Keyword;
• Must start with a letter;
• Must contains only letters, numbers and the underline char ('_');
• Max length of 50 chars;

Example:

UIServices:
- Name: My_First_UIService

---

Entity

The name of business entity linked to this uiservice.

Requirements Rules:

• Is Required;
• The referenced entity must have a KeyType;
• The name must exist in Entities list in the current model;
  • See Entity section for more details.

Example:

UIServices:
- Name: My_First_UIService
  Entity: My_First_Entity

---

CrudService

The name of business service linked to this uiService for CRUD operations.

Requirements Rules:

• Is Required;
• Must exist in Services list in the current model
  • See Service section for more details.

Example:

UIServices:
- Name: My_First_UIService
  Entity: My_First_Entity
  CrudService: My_CRUD_Service

---

CrudController

The name of the 'Crud' type controller linked to the chosen CrudService, which will be used to perform CRUD operations.

Requirements Rules:

• Is Required;
• Must exist in Controllers list in the current model
  • See Controllers section for more details.

Example:

UIServices:
- Name: My_First_UIService
  Entity: My_First_Entity
  CrudService: My_CRUD_Service
  CrudController: My_CRUD_Controller

---

QueryService

The name of business service linked to this uiService for QUERY operations.

Requirements Rules:

• Is Required if this uiService is being referenced as a service in some UiStructure;
• Must exist in Services list in the current model
  • See Service section for more details.

Example:

UIServices:
- Name: My_First_UIService
  Entity: My_First_Entity
  CrudService: My_CRUD_Service
  CrudController: My_CRUD_Controller
  QueryService: My_QUERY_Service

---

QueryController

The name of the 'Query' type controller linked to the chosen QueryService, which will be used to perform QUERY operations.

Requirements Rules:

• Is Required if this uiService is being referenced as a service in some UiStructure;
• Must exist in Controllers list in the current model
  • See Controllers section for more details.

Example:

UIServices:
- Name: My_First_UIService
  Entity: My_First_Entity
  CrudService: My_CRUD_Service
  CrudController: My_CRUD_Controller
  QueryService: My_QUERY_Service
  QueryController: My_QUERY_Controller

---