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/partners/altair/altair-graph-studio.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,11 +95,17 @@ You now have a graph ontology in Altair Graph Studio with data and a SPARQL quer
95
95
96
96
Altair Graph Studio allows you to do much more, such as ingesting data from data lakes or APIs and linking siloed data into one unified ontology, but for now you can focus on this basic graph.
97
97
98
-
## Exposing the Data via an OData REST Endpoint
98
+
## Exposing Graph Data in the Mendix Application
99
+
100
+
Altair Graph Studio (AGS) allows you to store and retrieve graph data structures. Using either OData REST endpoints or SPARQL queries via the SPARQL API endpoint, you can retrieve this data into your Mendix application.
101
+
102
+
The OData approach provides the easiest integration with automatic entity mapping and association handling, while the SPARQL approach offers more control for complex graph queries. Both methods enable you to build powerful applications that leverage the scalability and flexibility of graph databases.
103
+
104
+
### Exposing the Data via an OData REST Endpoint
99
105
100
106
The simplest way to use Graph data in a Mendix application is by using an OData endpoint. In Altair Graph Studio, you can export an entire graph via OData. This will create an OData endpoint allowing flexible OData queries on the data in your graph database.
101
107
102
-
###Create an OData API in Graph Studio
108
+
#### Creating an OData API in Graph Studio
103
109
104
110
Create a new OData API in your graphmart. To do this, follow the steps below.
105
111
@@ -121,7 +127,7 @@ Create a new OData API in your graphmart. To do this, follow the steps below.
121
127
122
128
4. To see the contract of the endpoint, use the endpoint URL displayed in the endpoint configuration page under **ODBC (SQL)** and append `/$metadata` to this URL. You will need it when using the endpoint in Studio Pro.
123
129
124
-
###Use the OData Endpoint in a Mendix Project
130
+
#### Using the OData Endpoint in a Mendix Project
125
131
126
132
Add a [consumed OData service](/refguide/consumed-odata-service/) in your project by opening Studio Pro and right-clicking your module > **Add other** > **Consumed OData service**. In the **Add Consumed OData Service** dialog, provide the location of the endpoint `$metadata` contract, as well as your username and password credentials. Studio Pro will read the contract to determine all the entities and actions provided by this endpoint.
127
133
@@ -131,29 +137,29 @@ In the consumed OData service document, you can provide configuration for the en
###Create External Entities for Datasets from the OData Endpoint
140
+
#### Creating External Entities for Datasets from the OData Endpoint
135
141
136
142
The [Integration pane](/refguide/integration-pane/) in the right column displays all the graph classes exposed via the OData REST API. You can see the attributes (properties) of these classes and the associations. The Integration pane also shows the capabilities of the data provided by the endpoint. In this example, all the data is read-only, as the Altair Graph Database only provides read-only access to the data.
137
143
138
144
Select which classes you need for your application and drag and drop them into a domain model. Here, they will be displayed as purple external entities. This indicates that the data is available to your application but is retrieved from an external service (in this case, the Altair Graph Database).
You can use these external entities in your pages and microflows similarly to persistent entities. For this example, create your overview pages by right-clicking the entity and selecting **Generate overview pages**.
You can now start the application and test the results. Whenever you open a page using external entities from the Integration pane, the data will automatically be retrieved from Altair Graph Studio via an OData REST call.
Filtering, sorting, and pagination are automatically done server-side by your graph database. This is essential for large datasets to avoid overloading the front-end with too many objects.
155
161
156
-
### Lazy-Loaded Tree Widget
162
+
####Lazy-Loaded Tree Widget
157
163
158
164
Altair Graph Studio automatically provides associations for linked entities in your graph. These graph associations are part of the OData endpoint and part of your external entities. When you drag your OData datasets into your domain model, the resulting external entities will show associations from the OData endpoint.
159
165
@@ -165,11 +171,11 @@ This is done automatically when you set the external entities as the data source
If you need full control over your graph queries, you can use [consumed REST services](/refguide/consumed-rest-service/) to execute SPARQL queries in your graph database.
171
177
172
-
### Configuring the REST Call
178
+
####Configuring the REST Call
173
179
174
180
Run SPARQL queries from Mendix by using the SPARQL API in Altair Graph Studio. To do this, follow the steps below.
175
181
@@ -198,7 +204,7 @@ Run SPARQL queries from Mendix by using the SPARQL API in Altair Graph Studio. T
Define a microflow that will execute the API call with the SPARQL query and return the resulting data as an entity list. In this example, the endpoint is defined using two constants:
204
210
@@ -209,13 +215,13 @@ By using constants, you can override these on deployment to match the environmen
Create a page that will show the retrieved data. This example uses a [Data Grid 2](/appstore/modules/data-grid-2/) with a microflow data source. The microflow data source is configured to use the microflow that was created in the previous step.
You can now run your application to validate the result. It should have a data grid showing all objects and a detail form showing the details of one specific object, as seen below:
221
227
@@ -224,9 +230,3 @@ You can now run your application to validate the result. It should have a data g
224
230
You should also see detail pages that show data from a single concept in your graph database:
As illustrated, Altair Graph Studio (AGS) allows you to store and retrieve graph data structures. Using either OData REST endpoints or SPARQL queries via the SPARQL API endpoint, you can retrieve this data into your Mendix application.
231
-
232
-
The OData approach provides the easiest integration with automatic entity mapping and association handling, while the SPARQL approach offers more control for complex graph queries. Both methods enable you to build powerful applications that leverage the scalability and flexibility of graph databases.
0 commit comments