You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/domain-model/entities/view-entities/_index.md
+24-5Lines changed: 24 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,13 +29,32 @@ Your app must use OQL version 2 to use view entities. You can change this settin
29
29
30
30
## Properties
31
31
32
-
After adding a view entity, you can specify the OQL query by double-clicking the entity to open the view entity properties dialog:
32
+
Double-clicking a view entity to open its properties dialog box. An example of a view entity's properties dialog box is represented in the image below:
View entity properties consist of the following sections:
37
37
38
-
The **General** field contains the **OQL editor** and the **Preview data** table.
38
+
*[General](#general)
39
+
*[OQL editor](#oql-editor)
40
+
*[Access rules](#access-rules)
41
+
*[Documentation](#documentation)
42
+
43
+
### General Section {#general}
44
+
45
+
#### Name {#name}
46
+
47
+
The name property defines the name of the view entity. This name is used to refer to the view entity in forms, microflows, queries, constraints, etc.
48
+
49
+
The name has to be unique only within the domain model of a module. You can have two view entities with the same name, provided that they are in the domain models of different modules.
50
+
51
+
#### Image {#image}
52
+
53
+
The image property can be used to associate an image with a view entity. In the domain model, this image is shown in the top-left corner of the view entity. The image is also shown in other places where view entities are mentioned, such as the entity selection pop-up window when selecting an entity for a data view.
54
+
55
+
### OQL Editor Section {#oql-editor}
56
+
57
+
This section contains the **OQL editor** and the **Preview data** table.
39
58
40
59
The **OQL editor** allows you to write the query that defines this view entity. While writing this query, the editor suggests names of the entities and attributes in your domain model, as well as allowed clauses, operators, and functions. If the query is not valid, a list of validation errors will be displayed underneath the editor with the line and column number of the place where the error was found.
41
60
@@ -45,15 +64,15 @@ The resulting names and types of the attributes will be displayed as column head
45
64
The **Preview data** table tries to retrieve the data using your OQL query from the running app. This means if you have changed your domain model since you last started the app, you can run into errors when the OQL query uses attributes or entities that do not yet exist in the version of the app that is running.
46
65
{{% /alert %}}
47
66
48
-
### Access Rules
67
+
### Access Rules {#access-rules}
49
68
50
69
When the security level of the app is set to **Production**, the **Access rules** tab becomes available in the view entity properties.
51
70
52
71
Assigning write access to an attribute allows the selected module role to edit the in-memory representation of the query result, but not the underlying source entity. The access level set on the view entity is the sole determining factor for whether a role can read or write to it. The access levels of underlying entities are not considered. This is crucial to prevent unintended exposure of data that is restricted at the source entity level.
53
72
54
73
Direct writing from the view entity to its source entities is not supported, but you can set up a microflow to retrieve and update the source entities to achieve this.
55
74
56
-
### Documentation
75
+
### Documentation {#documentation}
57
76
58
77
You can add any local information about the view entity in this tab. This is also available to other users working on the app.
0 commit comments