Business Object

12 min

Business Objects are the link between Neuro and a Data Entity of the applications. In this way, the Business Object will represent the data model and may reach one or more forms.

Each business object created represents a table in the database.

Before getting started

Must have a DB Connection and Neuro Application created.

General data

Access the functionality through navigation in the menu Neuro > Management > Business Object;
Click on "New";
Complete the fields available for the "Identification" tab;
Select the Application for which the business object is created, give the Business Object a Name and a Description, also inform the purpose of the Business Object;

Figure 1 - Identification

Database Information

Complete the fields available for the "Database" tab, this tab refers to the database structure of the application. Since each business object represents a database table, this tab defines the database columns as well as their relationships, business rules, and SQL commands (if necessary).
Fill the information with:
1. The Database Connection created;
2. The Database Scheme name;
3. Type, whether view or table;
4. The Name in Database of the business object.

Figure 2 - Database

Columns

Add the columns of the table, indicating
1. Inform the Column name in DB;
2. Select the Type of the Column, the system will make the correlation automatically to the Type in DB;
3. Give the Name object attribute, if you don't change it will take the same name as the column name;
4. Set the Label for the form and grid;
5. Select Primary key if the column is the Primary key for the table;
6. Select Required if the column is mandatory;
7. Click on "Save”.

NOTE:

After Saving, you will be able to inform Domain key and type and assign the Relationship if it is needed.

Figure 3 - Columns List

Figure 4 - Adding New Columns

ATTENTION:

On each change of database or by the time of the creation of the business object, you must run the correspondent DDL to run the creation/change in the Database.

Relationship

If necessary, you can add Relationships at this tab;
Define:
1. Type (1 x N, N x 1);
2. Inform the Relationship name and the Label (to the form);
3. The Referenced object that will be linked;
4. The Column for auto-complete;
5. Set If it is Required field;
6. Delegation use when you want to use Generalization/Specialization concepts for the Relationship;
7. Set with Business object Colum will be part of the relationship.

Figure 5 - Relationship

Business Rules

Select the Business Rule assigned for insert, change or delete action on the Business Object;

Figure 6 - Business Rules

SQLs

You can create SQL's related to the business object to be used in the flow, for example:

a) In a task for the request of enrollment in courses you can create a SQL (it will be considered as a function) to get the number of students enrolled in a course;

b) The SQL will run under an ESI Flow and will be called by the SM Flow (using the component for integration with ESI Flow).

Figure 7 - SQL

Form (CRUD & Custom)

You can change the attribute labels through the Labels tab, and you can edit the grid fields using the Grid tab.

Figure 8 - Labels

Figure 9 - Grid

Clicking the Edit Form button in the screen header will generate a form for this business object. If there is no form for this business object, the Fields sidebar will be displayed. If there is already a previously registered form linked to this form, the Screen Drawing tab for this form will be opened.