Skip to content

Commit e65af6a

Browse files
authored
Merge branch 'Mendix-11' into qt-privatevaluescommand
2 parents a923d56 + d2e7278 commit e65af6a

File tree

1,038 files changed

+7953
-7615
lines changed

Some content is hidden

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

1,038 files changed

+7953
-7615
lines changed

content/en/docs/apidocs-mxsdk/apidocs/deployment/private-cloud-deploy-api.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ The API does not generate unique UUIDs for the resources. You must generate your
102102

103103
The following sections of this document contain sample usage scenarios for the API.
104104

105-
### Using the API to Update the Cluster and Namespace
105+
### Using the API to Update the Cluster and Namespace {#update-cluster}
106106

107107
The following steps will create a cluster, register and install a namespace, add or update a cluster member, and enable development mode for the namespace.
108108

@@ -125,6 +125,21 @@ The following steps will create a cluster, register and install a namespace, add
125125
If required, the invitation for the cluster/namespace member can be auto-accepted by setting `autoAcceptInvite` to true in the update cluster/namespace API request.
126126
{{% /alert %}}
127127

128+
### Using the API to Assign a Custom Role to the Namespace Member {#assign-custom-role}
129+
130+
Perform the following steps to create a cluster, register and install a namespace, add a custom role in the Cluster Overview page in the portal, and assign the role to the namespace member:
131+
132+
1. Set up your authentication PAT.
133+
2. Prepare the manifest for both your new cluster and namespace.
134+
3. Configure the namespace by following steps 8-11 of [Using the API to Update the Cluster and Namespace](#update-cluster).
135+
4. Create a custom role in the Cluster Overview page in the portal. This role must be created only on the Portal side.
136+
5. Make a POST `/clusters/{namespaceId}` API call to assign the role that you created in step 4 to the namespace member.
137+
You can obtain the manifest for this update request through GET `/clusters/{namespaceId}`. When updating the namespace, only the role needs to be specified for the namespace member, as the fine-grained permissions are already included in the role created in step 4.
138+
139+
{{% alert color="info" %}}
140+
If required, the invitation for the cluster or namespace member can be auto-accepted by setting `autoAcceptInvite` to true in the update cluster or namespace API request.
141+
{{% /alert %}}
142+
128143
### Using the API to Restart an App {#restart}
129144

130145
The following steps will restart an app by setting the number of instances to zero and then setting it back to the number of instances required.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro/extensibility-api/csharp/extensibility-api-howtos/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ description_list: true
99

1010
## Introduction
1111

12-
The following how-tos teach you how to use the Extensibility API for C# Developers in different use cases.
12+
The following how-tos teach you how to use the Extensibility API for C# Developers in different use cases.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro/extensibility-api/packaging-your-extension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ Once the add-on module is available to a Studio Pro user, they are now able to a
2626

2727
Once an add-on module containing an extension is imported in the app, Studio Pro will show a warning to the user, asking to trust the extension contained in it. If the user does not choose to trust, the module will still be imported but the extension inside it won't be loaded.
2828

29-
![Trust Extension](/attachments/apidocs-mxsdk/apidocs/extensibility-api/trustExtension.png)
29+
![Trust Extension](/attachments/apidocs-mxsdk/apidocs/extensibility-api/trustExtension.png)

content/en/docs/apidocs-mxsdk/apidocs/studio-pro/extensibility-api/web/web-extensions-howtos/menu-api.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,6 @@ The menu has the following properties:
8383

8484
{{< figure src="/attachments/apidocs-mxsdk/apidocs/extensibility-api/web/menus/grouped_menus.png" >}}
8585

86-
8786
## Creating a Menu with Submenus
8887

8988
You can also have a number of submenus that branch out your menu.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro/runtime-api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Extend your application model using Java. All functionality and information from
1111

1212
## Mendix Runtime API
1313

14+
* [Mendix 11 Runtime API](https://apidocs.rnd.mendix.com/11/runtime/index.html)
1415
* [Mendix 10 Runtime API](https://apidocs.rnd.mendix.com/10/runtime/index.html)
1516
* [Mendix 9 Runtime API](https://apidocs.rnd.mendix.com/9/runtime/index.html)
1617
* [Mendix 8 Runtime API](https://apidocs.rnd.mendix.com/8/runtime/index.html)

content/en/docs/apidocs-mxsdk/mxsdk/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Presents documentation for Mendix SDKs, including Mendix Platform
66
---
77

88
{{% alert color="warning" %}}
9-
Mendix Platform SDK versions below 5.0 are deprecated. They depend on the [Projects API](/apidocs-mxsdk/apidocs/projects-api/) which will be removed early in 2024. A firm date will be communicated once a decision has been made.
9+
Mendix Platform SDK versions below 5.0 are deprecated.
1010
{{% /alert %}}
1111

1212
## Introduction

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ For an explanation on this topic, see [How to Manipulate Existing Models](/apido
4848
Some more explanation on manipulating existing models can be found in these documents:
4949

5050
* [How to Change Things in the Model](/apidocs-mxsdk/mxsdk/changing-things-in-the-model/)
51-
* [How to Close the Server Connection](/apidocs-mxsdk/mxsdk/closing-the-server-connection/)
5251
* [How to Find Things in the Model](/apidocs-mxsdk/mxsdk/finding-things-in-the-model/)
5352
* [How to Load Units and Elements](/apidocs-mxsdk/mxsdk/loading-units-and-elements/)
5453

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/creating-the-domain-model.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ customer.location = { x: 100, y: 100 };
5454
With these ingredients, you can create the two entities. Replace the snippet that creates a single entity in the script that you created in the [previous how-to steps](/apidocs-mxsdk/mxsdk/creating-your-first-script/) with the following snippet to create the two new entities:
5555

5656
```ts
57-
const domainModel = await loadDomainModel(workingCopy);
57+
const domainModel = await domainModelInterface.load();
5858
const customer = domainmodels.Entity.createIn(domainModel);
5959
customer.name = `Customer`;
6060
customer.location = { x: 100, y: 100 };
@@ -148,14 +148,16 @@ In the Model SDK, the [`Entity.generalization`](https://apidocs.rnd.mendix.com/m
148148
So, to set up entity `Customer` as a specialization of entity `Administration.Account`, you first need to look up the `Account` entity which [can be done in several ways](/apidocs-mxsdk/mxsdk/finding-things-in-the-model/). The following snippet looks up the `Account` entity in the `Administration` domain model, using the `findEntityByQualifiedName` function:
149149

150150
```ts
151-
const systemUser = workingCopy.model().findEntityByQualifiedName(`Administration.Account`);
151+
const systemUser = model.findEntityByQualifiedName(`Administration.Account`);
152152
```
153153

154154
The `domainmodels.Generalization` instance that will be used to configure the `Account` instance can now be created. The `generalization` property is set to the `System.User` entity instance that was looked up:
155155

156156
```ts
157-
const generalization = domainmodels.Generalization.createIn(customer);
158-
generalization.generalization = systemUser;
157+
if(systemUser){
158+
const generalization = domainmodels.Generalization.createIn(customer);
159+
generalization.generalization = systemUser;
160+
}
159161
```
160162

161163
Together, the creation of the `Customer` entity will look like the following code snippet. Replace the creation of the `customer` entity instance in the script with the following snippet:
@@ -166,8 +168,10 @@ customer.name = `Customer`;
166168
customer.location = { x: 100, y: 100 };
167169

168170
const generalization = domainmodels.Generalization.createIn(customer);
169-
const systemUser = workingCopy.model().findEntityByQualifiedName(`Administration.Account`);
170-
generalization.generalization = systemUser;
171+
const systemUser = model.findEntityByQualifiedName(`Administration.Account`);
172+
if (systemUser) {
173+
generalization.generalization = systemUser;
174+
}
171175
```
172176

173177
### Resources

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/creating-your-first-script.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ After setting up all the prerequisites, you can start writing a first script tha
4747

4848
Don't forget to [set up your personal access token](/apidocs-mxsdk/mxsdk/set-up-your-pat/) before executing the script.
4949

50+
{{% alert color="warning" %}}
51+
Working copy creation is a resource-intensive process. Consider reusing previously-created ones by invoking `app.getOnlineWorkingCopy(workingCopyId)`. All working copies are automatically deleted after 24 hours.
52+
{{% /alert %}}
53+
5054
### Code Explanation
5155

5256
Here are some explanations about the script:

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/manipulating-existing-models/changing-things-in-the-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,4 +106,4 @@ All the parts of a *deleted* element are also *deleted* and cannot be accessed.
106106

107107
## Next Step
108108

109-
Continue with [How to Close the Server Connection](/apidocs-mxsdk/mxsdk/closing-the-server-connection/).
109+
Continue with [How to Find Things in the Model](/apidocs-mxsdk/mxsdk/finding-things-in-the-model/).

0 commit comments

Comments
 (0)