Skip to content

Commit 119f0fa

Browse files
committed
Adjust documentation of service, remove changes for call external action
1 parent f29ae73 commit 119f0fa

File tree

3 files changed

+11
-21
lines changed

3 files changed

+11
-21
lines changed

content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/integration-activities/call-external-action.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,6 @@ The **Output** section shows what the action returns and allows you to rename it
5555

5656
If the action returns an entity that has associations, you can select the associations that you want to have populated in the resulting variable. You can then use the **Retrieve object(s)** activity to retrieve the associated objects over the association.
5757

58-
{{% alert color="info" %}}
59-
The support for OData actions that return entity type having Collection attribute(s) of supported primitive types, was introduced in [Studio Pro 11.6.0](/releasenotes/studio-pro/11.6/).
60-
{{% /alert %}}
61-
6258
## Documentation Tab {#public-documentation}
6359

6460
In the **Documentation** tab, you can find a **Summary** and a **Description**. These fields contain public documentation provided by the author of the service.
@@ -85,14 +81,6 @@ If you have selected a variable for an entity that is an open type (`OpenType="t
8581
The ability to add additional attributes was introduced in [Studio Pro 11.5.0](/releasenotes/studio-pro/11.5/).
8682
{{% /alert %}}
8783

88-
### Collection Attributes {#collection-attributes}
89-
90-
When assigning a value to an entity type parameter that has collection attributes (Mendix-supported primitive types; e.g., a list of strings), select the corresponding attribute of matching type from list variable (list of objects) — Mendix will automatically use the whole list to populate the collection values.
91-
92-
{{% alert color="info" %}}
93-
The support for OData actions with parameter entity type having Collection attribute(s) of supported primitive types, was introduced in [Studio Pro 11.6.0](/releasenotes/studio-pro/11.6/).
94-
{{% /alert %}}
95-
9684
### Associations to Include
9785

9886
If you have selected a variable for an entity that has associations, you can select the associations you want to include in the arguments that you call the external action with.

content/en/docs/refguide/modeling/integration/odata-services/consumed-odata-services/consumed-odata-service-requirements.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ The most commonly used attribute types can be used in your app. The types of the
8888
| Enumeration | Enumeration |
8989
| Int64 | Long |
9090
| String, Guid | String |
91-
| Collection | List (see [Collection Attributes](#collection-attributes) below)|
91+
| Collection | List (see [Collection Attributes](#collection-properties) below) |
9292
| (Other) | (Ignored) |
9393

9494
¹ In Studio Pro, Booleans cannot be null. If the service returns null, the app will use the value `false`.
@@ -123,13 +123,18 @@ The binary data format is supported in the form of *media entities*. When a medi
123123

124124
Currently, the binary data can only be accessed by Java actions.
125125

126-
### Collection Attributes {#collection-attributes}
126+
### Collection Properties {#collection-properties}
127127

128-
Collection attributes (Mendix-supported primitive types) are supported in OData entity type when consumed as an external entity.
129-
When an entity type with supported Collection attribute(s) is added to the domain model, each of its Collection attributes is represented as a non-persistable entity (associated as a one-way navigable Reference-set to original attribute containing entity type). The domain model entity corresponding to the collection attribute contains a single attribute (having same primitive type as the type of Collection in the OData metadata).
128+
Entity type properties that are a collection of a supported attribute type are supported through the use of a associated non-persistable entity.
129+
130+
Take for example a `Product` entity type has an attribute `Tags` with type `Collection(Edm.String)`. The resulting domain model looks as follows:
131+
132+
{{< figure src="/attachments/refguide/modeling/integration/odata-services/consumed-odata-service/collection-of-primitives.png" alt="A product entity with an associated ProductTag entity. The ProductTag entity has a Tag attribute" width="531" class="no-border" >}}
133+
134+
For entity sets these properties are not supported. This means that they can only be used in parameters and return values of external actions.
130135

131136
{{% alert color="info" %}}
132-
The support for OData actions with parameter entity type having Collection attribute(s) of supported primitive types, was introduced in [Studio Pro 11.6.0](/releasenotes/studio-pro/11.6/).
137+
Collection properties were introduced in [Studio Pro 11.6.0](/releasenotes/studio-pro/11.6/).
133138
{{% /alert %}}
134139

135140
### Associations
@@ -164,18 +169,15 @@ Supported types, and their corresponding type in Mendix, are:
164169
| Entity | Object ³ |
165170
| Enumeration | Enumeration |
166171
| String, Guid | String |
167-
| Collection | List ⁴ |
168172

169-
Note that the only supported Collection type is a Collection of Entities, Collection of mendix-supported primitives, and that binary parameters or return values are not supported for consumed OData actions.
173+
Note that the only supported Collection type is a Collection of Entities, and that binary parameters or return values are not supported for consumed OData actions.
170174

171175
¹ In Mendix, Booleans cannot be null. If the action returns null, the value will be false in Mendix.
172176

173177
² Decimal values outside of the range of a Mendix [Decimal](/refguide/attributes/#type) are currently not supported. If the action returns a value outside of the range, the action will return an error.
174178

175179
³ Objects that contain attributes of complex types are not currently supported in actions.
176180

177-
⁴ Collection of Mendix-supported primtive types, see more details in [Using Collection-type attributes in Call External Action](/refguide/call-external-action/#collection-attributes)
178-
179181
{{% alert color="warning" %}}
180182
When the OData endpoint contains functions, these are not imported in the consumed OData service. You can use a [Call REST service](/refguide/call-rest-action/) activity to call these functions.
181183
{{% /alert %}}
8.13 KB
Loading

0 commit comments

Comments
 (0)