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/appstore/creating-content/connector-guide-build/_index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Connectors can be used in your app to simplify connecting to existing third-part
35
35
36
36
### Connecting to Other Systems
37
37
38
-
Connectors are implemented as Mendix modules with a focus on connecting to other systems. Connectors can make use of any of the platform-supported protocols like [SOAP](/refguide/consumed-web-services/#soap), [REST](/refguide/consumed-rest-services/#rest), [OData](/refguide/consumed-odata-services/#external-entities), or [Catalog](/catalog/).
38
+
Connectors are implemented as Mendix modules with a focus on connecting to other systems. Connectors can make use of any of the platform-supported protocols like [SOAP](/refguide/consumed-web-services/#soap), [REST](/refguide/integration/rest-services/), [OData](/refguide/consumed-odata-services/#external-entities), or [Catalog](/catalog/).
39
39
40
40
They can also be used to package a Java library provided by the other system to make the connection. These Java library functions can be exposed via Java actions as custom microflow activities (see [How to Build Microflow Actions with Java](/howto/extensibility/howto-connector-kit/)). This makes it simpler for Mendix developers without in-depth knowledge about third-party integrations to use these connectors in their business logic.
41
41
@@ -59,7 +59,7 @@ This chart shows the available solutions for when you want to connect Mendix app
59
59
| Unsupported protocols | Build a module to connect either via alternative protocols, or by encapsulating one of the platform supported protocols. |
60
60
61
61
{{% alert color="info" %}}
62
-
The [Catalog](/catalog/) is a hub for shared registered assets made available in your organization. At the moment, it only supports OData.
62
+
The [Catalog](/catalog/) is a hub for shared registered assets made available in your organization. At the moment, it supports OData, REST, and Business Events.
Copy file name to clipboardExpand all lines: content/en/docs/appstore/platform-supported-content/modules/any-chart.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ description: "Describes the configuration and usage of the Any Chart module, whi
7
7
8
8
## Introduction
9
9
10
-
The [Any Chart](https://marketplace.mendix.com/link/component/106517/) module contains chart types supported in [plotly.js version 1.47.4](https://www.npmjs.com/package/plotly.js/v/1.47.4).
10
+
The [Any Chart](https://marketplace.mendix.com/link/component/106517/) module contains chart types supported in [plotly.js version 2.35.2](https://www.npmjs.com/package/plotly.js/v/2.35.2).
11
11
12
12
Further documentation on usage can be found in the following pages locations:
Copy file name to clipboardExpand all lines: content/en/docs/appstore/platform-supported-content/modules/genai/_index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,5 +84,5 @@ The available showcase applications offer implementation inspiration for many of
84
84
In addition to the models listed above, you can also connect to other models by implementing one of the following options:
85
85
86
86
* To connect to other [foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/models-features.html) and implement them in your app, use the [Amazon Bedrock connector](/appstore/modules/aws/amazon-bedrock/).
87
-
* To connect to [Snowflake Cortex LLM](https://docs.snowflake.com/en/sql-reference/functions/complete-snowflake-cortex) functions, use the [Snowflake connectors](/appstore/snowflake-modules/).
87
+
* To connect to [Snowflake Cortex LLM](https://docs.snowflake.com/en/sql-reference/functions/complete-snowflake-cortex) functions, [configure the Snowflake REST SQL connector for Snowflake Cortex Analyst](/appstore/connectors/snowflake/snowflake-rest-sql/#cortex-analyst).
88
88
* To implement your own connector compatible with the other components, use the [GenAI Commons](/appstore/modules/genai/commons/) interface.
description: "Describes the configuration and usage of the Mendix-Snowflake REST SQL connector from the Mendix Marketplace."
4
+
description: "Describes the configuration and usage of the Mendix-Snowflake REST SQL connector from the Mendix Marketplace."
5
5
weight: 20
6
6
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
7
7
---
@@ -18,12 +18,15 @@ The Snowflake REST SQL connector provides a way to first setup key-pair authenti
18
18
* Write data to Snowflake
19
19
* Trigger [Snowflake Cortex ML functions](https://docs.snowflake.com/en/guides-overview-ml-functions)
20
20
* Use [Snowflake Cortex LLM functions](https://docs.snowflake.com/en/user-guide/snowflake-cortex/llm-functions)
21
+
* Use [Snowflake Cortex Analyst](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-analyst)
21
22
22
-
The current version of the connector supports the following actions:
23
+
The current version of the connector supports the following:
23
24
24
25
* Authentication with an RSA key pair according to PKCS #8 standard
26
+
* Authentication with OAUTH through an OIDC provider
25
27
* Execution of single SQL statements
26
28
* Synchronous execution of calls
29
+
* Execution of a Cortex Analyst query
27
30
28
31
### Prerequisites {#prerequisites}
29
32
@@ -33,6 +36,7 @@ To use the Snowflake REST SQL connector, you must also install and configure the
33
36
34
37
*[Community Commons](https://marketplace.mendix.com/link/component/170) - This module is a required dependency for the Snowflake REST SQL connector.
35
38
*[Encryption](https://marketplace.mendix.com/link/component/1011) - This module is a required dependency for the Snowflake REST SQL connector. The EncryptionKey constant must be set up in your application settings.
39
+
*[GenAI Commons](https://marketplace.mendix.com/link/component/227933)- This module is a required dependency for the Snowflake Cortex Analyst.
36
40
37
41
### Licensing and Cost
38
42
@@ -96,6 +100,7 @@ After you configure the authentication for Snowflake, you can implement the func
To help you work with the Snowflake REST SQL connector, the following sections of this document list the available entities, enumerations, and activities that you can use in your application.
@@ -205,3 +210,45 @@ FROM your_table
205
210
```
206
211
207
212
This statement returns data from a Snowflake table with the columns named as specified with the `as **NewColumnName**" part` of each line. If the attribute names, datatypes and their order match, the `TransformResponsesToMxObjects` activity automatically converts the retrieved data into Mendix objects.
Cortex Analyst is a fully-managed, LLM-powered Snowflake Cortex feature that helps you create applications capable of reliably answering business questions based on your structured data in Snowflake.
217
+
218
+
{{% alert color="info" %}}
219
+
Snowflake Cortex Analyst is currently in open preview. For more information, refer to the [Snowflake Cortex Analyst documentation](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-analyst).
220
+
{{% /alert %}}
221
+
222
+
### Prerequisites
223
+
224
+
* Make sure that you have access to Cortex Analyst. For more information, refer to the [Snowflake Cortex Analyst documentation](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-analyst).
225
+
* Create the semantic model for Cortex Analyst. For more information, refer to [Creating Semantic Models for Snowflake Cortex Analyst](https://developers.snowflake.com/solution/creating-semantic-models-for-snowflakes-cortex-analyst/) in the Snowflake Cortex Analyst documentation.
226
+
* Set up one of the following supported authentication methods for Cortex Analyst:
227
+
* OAUTH
228
+
* WT-Keypair
229
+
230
+
### Configuration
231
+
232
+
To configure your Mendix app for Snowflake Cortex Analyst, perform the following steps:
233
+
234
+
1. Create a microflow and add the **Cortex Analyst: Create Cortex Analyst Connection** action from the **Toolbox**.
235
+
2. Provide the following mandatory information:
236
+
***Token** - The authentication token created from the OIDC provider, or the JWT Token
237
+
***AccountURL** - The URL of the Snowflake account that has access to Snowflake Cortex Analyst
238
+
***Authentication Type**
239
+
3. Add the **Cortex Analyst: Create Request** action from the **Toolbox**, and then configure the **Request** to contain the path to the Snowflake semantic model file.
240
+
3. Add the **Chat: Add Message to Request** action from the Toolbox and provide the following information:
241
+
***Request** - The request that you configured for the **Cortex Analyst: Create Request** action
242
+
***ENUM_MessageRole** - The role of the entity that creates the message; in the current version, the role must be set to **user**
243
+
***ContentString** - The text of the question for Cortex Analyst
244
+
4. Add the **Snowflake Cortex Analyst** action from the Toolbox and provide the following information:
245
+
***Connection** - The Cortex Analyst connection that you configured for the **Cortex Analyst: Create Cortex Analyst Connection** action
246
+
***Request** - The request that you configured for the **Cortex Analyst: Create Request** action
247
+
5. To get the response message from the response, add the **Response: Get Cortex Analyst Response Message** action from the Toolbox, and then add the **Response** entity as a parameter. The message contains the following information:
248
+
***Content** - This is the content of the response message. It includes the text and the SQL, or the suggestions if no SQL is returned
249
+
***Cortex Role** - The entity that produced the message; possible values are *user* or *analyst*
250
+
***SQLText** - The returned SQL suggestion
251
+
6. To get the Cortex Analyst Response entity, add the **Response: Get Cortex Analyst Response** action from the Toolbox, and then add the **Response** entity as a parameter. The response contains the following information:
REST services provided by Mendix Apps running in Mendix Cloud (published [OData](/refguide/published-odata-services/) and OpenAPI REST Services) are automatically registered in your organization's Catalog upon deployment. This provides you with an up-to-date view of all the ODataand OpenAPI REST APIs published and consumed by your Mendix apps. These assets can be [curated](/catalog/manage/curate/) in the Catalog to ensure that they are exposed to the relevant users and can be found easily.
27
+
REST services provided by Mendix Apps running in Mendix Cloud (published [OData](/refguide/published-odata-services/) and OpenAPI REST Services) and Business Events are automatically registered in your organization's Catalog upon deployment. This provides you with an up-to-date view of all the OData, OpenAPI, and Business Event endpoints published and consumed by your Mendix apps. These assets can be [curated](/catalog/manage/curate/) in the Catalog to ensure that they are exposed to the relevant users and can be found easily.
28
28
29
29
Learn about updates and improvements in the [Catalog](/releasenotes/data-hub/) release notes.
Copy file name to clipboardExpand all lines: content/en/docs/catalog/get-started.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ You can use the Catalog with any deployment method, though there are differences
31
31
32
32
| Deployment Method | How are Data Sources Registered? |
33
33
| --- | --- |
34
-
|[Mendix Cloud](/developerportal/deploy/mendix-cloud-deploy/)| Published OData services in a deployed app are [registered automatically](/catalog/register/register-data/#mendix-cloud) as data sources in the Catalog <br> [Register sources using the Registration API](/catalog/register/register-data/#register-services)|
34
+
|[Mendix Cloud](/developerportal/deploy/mendix-cloud-deploy/)| Published OData/REST services and Business Events services in a deployed app are [registered automatically](/catalog/register/register-data/#mendix-cloud) as data sources in the Catalog <br> [Register sources using the Registration API](/catalog/register/register-data/#register-services)|
35
35
|[Private Cloud](/developerportal/deploy/private-cloud/)| Using the [Registration API](/catalog/register/register-data/#register-services)|
36
36
|[On-Premises](/developerportal/deploy/on-premises-design/)| Using the [Registration API](/catalog/register/register-data/#register-services)|
Copy file name to clipboardExpand all lines: content/en/docs/catalog/register/register-data.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,11 +16,11 @@ aliases:
16
16
17
17
## Introduction
18
18
19
-
There are three ways to register published services in the Catalog. Mendix supports all OData versions.
19
+
There are three ways to register published services in the Catalog. Mendix supports all OData versions, REST, and Business Events
20
20
21
21
This how-to teaches you how to register a service in the following ways:
22
22
23
-
*[Through Mendix Cloud](#mendix-cloud), where registration occurs automatically when you deploy a [published OData service](/refguide/published-odata-services/) to Mendix Cloud
23
+
*[Through Mendix Cloud](#mendix-cloud), where registration occurs automatically when you deploy a [published OData](/refguide/published-odata-services/)/REST service, or Business Event to Mendix Cloud
24
24
*[Through the Catalog Registration API](#registration-api)
25
25
*[Through the Catalog UI form](#registration-form)
26
26
@@ -30,7 +30,7 @@ Before starting this how-to, make sure you have completed the following prerequi
30
30
31
31
* You have Studio Pro [8.14.0 or above](https://marketplace.mendix.com/link/studiopro/) installed
32
32
* You have a Mendix account
33
-
* You have an exposed OData service that you are ready to register (for instructions on how to create an exposed OData service, refer to the sections on creating an app and exposing an entity in [Share Data Between Apps](/howto/integration/share-data/)
33
+
* You have an exposed OData/REST service or Business Event that you are ready to register (for instructions on how to create an exposed OData service, refer to the sections on creating an app and exposing an entity in [Share Data Between Apps](/howto/integration/share-data/)
34
34
35
35
## Registering a Service Through Mendix Cloud {#mendix-cloud}
0 commit comments