Endpoints definition allows you to define every menu option of your application. Yo can define as many as you want but none of them can have the same path.
 

1 Overview

Every endPoint is associated with an application code. The application loaded is defined in the config.xml file by its code. To define them, the menu can be found in: Business logic / SQL catalogue / Endpoints

The endPoints are defined by its type. When creating a new endPoint, the user must select between the types provided (List, Map, Chart, PDF, Menu, Form, Custom, Custom row view). Each type will render a different component.

 

2 Fields

To clarify every endPoint configuration parameter, let's explain them individually. Not every parameter have to be defined. It will depend on the endPoint type

 

2.1 Application code

Define the code of the parent application. This endPoint will be loaded only if the application with this code is running.

 

2.2 Hide in menu

This option allow the user to not display the endPoint in the left-side menu bar. Even not displaying the endPoint as a menu option, this will be accessible via the defined path.

 

2.3 Type

By this option, the user defines the type of view rendered. The options available are:

  • List
  • Map
  • Chart
  • PDF
  • Menu
  • Form
  • Custom
  • Custom row view

The first six components will render predefined components. The data used to display each component is defined in the Catalogued SQL field

Custom views allow the user to define a non-predefined view. The field Custom view is used to define de view to be displayed.

 

2.4 Label

This is a required field. The label code defined must be defined in the wic (wic_jdic_lbldata) and will be displayed as a title.

 

2.5 Catalogued SQL

Code from the SQL Statement which will be executed to get data to use in the view. This code must be defined in the SQL Statements table (wic_sqlc_object)

 

2.6 Catalogued transaction

Views such as Forms could do some transactions in the database. Here the user can define the code of the SQL Transaction defined in wic_sqlc_trx_ins_head table

 

2.7 Role

Endpoints can be displayed under role conditions. If a role is defined here, the endPoint will be displayed only if the user has this role.

 

2.8 upd_cond_expr

 

2.9 Custom view

As said before, Custom type endPoints need to have a Custom view defined. This view must be defined in the main.js file as a vue.js component in the source files application. As the other views, this custom views will receive, if defined, the data from the Catalogued SQL code.