Skip to content

Commit 5b954bb

Browse files
Merge branch 'development' into lz-company-apps-overview
2 parents 52185f5 + 5d6734d commit 5b954bb

File tree

166 files changed

+2258
-247
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

166 files changed

+2258
-247
lines changed

content/en/docs/appstore/creating-content/connector-guide-build/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Connectors can be used in your app to simplify connecting to existing third-part
3535

3636
### Connecting to Other Systems
3737

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/).
3939

4040
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.
4141

@@ -59,7 +59,7 @@ This chart shows the available solutions for when you want to connect Mendix app
5959
| Unsupported protocols | Build a module to connect either via alternative protocols, or by encapsulating one of the platform supported protocols. |
6060

6161
{{% 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.
6363
{{% /alert %}}
6464

6565
### Getting Mendix Connectors

content/en/docs/appstore/platform-supported-content/modules/any-chart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "Describes the configuration and usage of the Any Chart module, whi
77

88
## Introduction
99

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).
1111

1212
Further documentation on usage can be found in the following pages locations:
1313

content/en/docs/appstore/platform-supported-content/modules/excel-exporter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ The Excel Exporter is compatible with the [Excel Importer](/appstore/modules/exc
1313

1414
## Prerequisites
1515

16-
* [Install Mx Model Reflection](/howto/integration/using-the-excel-exporter/#download-modules) version 6.1.1 or higher
17-
* [Add MxReflection page and Excel Exporter page to the navigation](/howto/integration/using-the-excel-exporter/#add-navigation-items)
18-
* [Configure Mx Model Reflection](/howto/integration/using-the-excel-exporter/#configure-mx-model-reflection)
16+
* [Install Mx Model Reflection](/refguide/using-the-excel-exporter/#download-modules) version 6.1.1 or higher
17+
* [Add MxReflection page and Excel Exporter page to the navigation](/refguide/using-the-excel-exporter/#add-navigation-items)
18+
* [Configure Mx Model Reflection](/refguide/using-the-excel-exporter/#configure-mx-model-reflection)
1919

2020
## Configuration
2121

content/en/docs/appstore/platform-supported-content/modules/genai/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,5 @@ The available showcase applications offer implementation inspiration for many of
8484
In addition to the models listed above, you can also connect to other models by implementing one of the following options:
8585

8686
* 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).
8888
* To implement your own connector compatible with the other components, use the [GenAI Commons](/appstore/modules/genai/commons/) interface.

content/en/docs/appstore/platform-supported-content/modules/snowflake/snowflake-rest-sql.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Snowflake REST SQL Connector"
33
url: /appstore/connectors/snowflake/snowflake-rest-sql/
4-
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."
55
weight: 20
66
#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.
77
---
@@ -18,12 +18,15 @@ The Snowflake REST SQL connector provides a way to first setup key-pair authenti
1818
* Write data to Snowflake
1919
* Trigger [Snowflake Cortex ML functions](https://docs.snowflake.com/en/guides-overview-ml-functions)
2020
* 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)
2122

22-
The current version of the connector supports the following actions:
23+
The current version of the connector supports the following:
2324

2425
* Authentication with an RSA key pair according to PKCS #8 standard
26+
* Authentication with OAUTH through an OIDC provider
2527
* Execution of single SQL statements
2628
* Synchronous execution of calls
29+
* Execution of a Cortex Analyst query
2730

2831
### Prerequisites {#prerequisites}
2932

@@ -33,6 +36,7 @@ To use the Snowflake REST SQL connector, you must also install and configure the
3336

3437
* [Community Commons](https://marketplace.mendix.com/link/component/170) - This module is a required dependency for the Snowflake REST SQL connector.
3538
* [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.
3640

3741
### Licensing and Cost
3842

@@ -96,6 +100,7 @@ After you configure the authentication for Snowflake, you can implement the func
96100

97101
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/example_implementation.png" >}}
98102

103+
99104
## Technical Reference
100105

101106
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
205210
```
206211

207212
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.
213+
214+
## Configuring Snowflake Cortex Analyst {#cortex-analyst}
215+
216+
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:
252+
* **Request_ID** - The returned *RequestId*
253+
254+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/CortexAnalystRequestExample.png" >}}

content/en/docs/catalog/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The [Catalog](https://catalog.mendix.com) is a development tool provided in Mend
2424

2525
{{< figure src="/attachments/catalog/catalog-home.png" class="no-border" >}}
2626

27-
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 OData and 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.
2828

2929
Learn about updates and improvements in the [Catalog](/releasenotes/data-hub/) release notes.
3030

content/en/docs/catalog/get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You can use the Catalog with any deployment method, though there are differences
3131

3232
| Deployment Method | How are Data Sources Registered? |
3333
| --- | --- |
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) |
3535
| [Private Cloud](/developerportal/deploy/private-cloud/) | Using the [Registration API](/catalog/register/register-data/#register-services) |
3636
| [On-Premises](/developerportal/deploy/on-premises-design/) | Using the [Registration API](/catalog/register/register-data/#register-services) |
3737

content/en/docs/catalog/register/register-data.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ aliases:
1616

1717
## Introduction
1818

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
2020

2121
This how-to teaches you how to register a service in the following ways:
2222

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
2424
* [Through the Catalog Registration API](#registration-api)
2525
* [Through the Catalog UI form](#registration-form)
2626

@@ -30,7 +30,7 @@ Before starting this how-to, make sure you have completed the following prerequi
3030

3131
* You have Studio Pro [8.14.0 or above](https://marketplace.mendix.com/link/studiopro/) installed
3232
* 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/)
3434

3535
## Registering a Service Through Mendix Cloud {#mendix-cloud}
3636

0 commit comments

Comments
 (0)