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/refguide/modeling/integration/odata-services/consumed-odata-services/consumed-odata-service.md
+37-29Lines changed: 37 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,32 +35,42 @@ The **Consumed OData Service** document contains the following information:
35
35
You can use either constants or a microflow to set the service URL and proxy settings.
36
36
37
37
- Use constants when the service URL and proxy settings are always the same.
38
-
- Use a connection microflow when you need more control. See section [connection and headers microflow](#connection-and-headers-microflow)below for more details.
38
+
- Use a connection microflow when you need more control. For more information, see the [Connection and Headers Microflow](#connection-and-headers-microflow)section below.
39
39
40
-
### Service URL {#service-url}
40
+
####Service URL {#service-url}
41
41
42
42
The **Service URL** displays a constant that specifies the URL of the service endpoint:
43
43
44
-
- Click **Select** to choose another [constant](/refguide/constants/) for the service.
45
-
- Click **Show** to open the **Constant** dialog box displaying the service URL or endpoint.
44
+
- Click **Select** to choose another [constant](/refguide/constants/).
45
+
- Click **Show** to open the **Constant** dialog box and view the service URL or endpoint.
46
46
47
-
### Connection microflow
47
+
####Connection microflow
48
48
49
-
The **Connection microflow** displays the microflow that the app uses to retrieve the service URL, proxy settings and headers. See section [connection and headers microflow](#connection-and-headers-microflow) for details about how to create such a microflow.
49
+
The **Connection microflow** displays the microflow that the app uses to retrieve the service URL, proxy settings and headers. See the [Connection and Headers Microflow](#connection-and-headers-microflow) section below for details about how to create such a microflow.
For Studio Pro 11.12 and below, there are three ways to specify the service URL, headers, and proxy settings: **Constants only**, **Configuration microflow**, and **Headers microflow**.
57
+
58
+
***Constants only** – specify the service URL, proxy settings, and headers using constants
59
+
***Configuration microflow** – specify the service URL, proxy settings, and headers using a microflow that returns a **System.ConsumedODataConfiguration**
60
+
***Headers microflow** – specify headers using a microflow that returns a list of **System.HttpHeader** and specify the service URL and proxy settings using constants
61
+
62
+
For more information, see the [Connection and Headers Microflow](#connection-and-headers-microflow) section below.
63
+
64
+
### Proxy Configuration
57
65
58
66
**Proxy configuration** allows you to configure a proxy for the request:
59
67
60
68
-**Follow app settings** – use settings which are defined at the app level (default).
61
69
-**Override app settings** – override the app-level settings for this action by specifying constants for the host, port, user name, and password for the proxy.
62
70
-**No proxy** – do not use a proxy for this service, even if there is a proxy configured at the app level.
The choice for **Basic authentication**specifies if basic authentication should be used. If selected, specify the following details:
82
+
Select **Basic authentication**to use basic authentication. If selected, specify the following details:
73
83
74
-
-**User name** – an expression for the user name that will be used for authentication.
75
-
-**Password** – an expression the password that will be used for authentication.
84
+
-**User name** – an expression for the user name used for authentication
85
+
-**Password** – an expression for the password used for authentication
76
86
77
-
In addition to basic authentication, you can also use custom authentication. For more information, see the [HTTP Headers](#http-headers) section below.
87
+
You can also use custom authentication. For more information, see the [HTTP Headers](#http-headers) section below.
Choose**Add headers** to add specify additional HTTP request headers to be passed to the endpoint.
93
+
Select**Add HTTP headers** to specify additional HTTP request headers to be passed to the endpoint. The field allows you to add, edit, and delete custom HTTP headers. Each custom header is a pair with a key and a value.
84
94
85
-
The list allows you to **Add**, **Edit**, or **Delete** custom HTTP headers. Each custom header is a pair with a key and a value.
95
+
The **Headers microflow**allows you to choose a microflow that returns a list of **System.HttpHeader**. For details on how to create such a microflow, see the [Connection and Headers Microflow](#connection-and-headers-microflow) section below.
86
96
87
-
The **Headers microflow** allows you to choose a microflow that returns a list of **System.HttpHeader**. See section [connection and headers microflow](#connection-and-headers-microflow) for details about how to create such a microflow.
97
+
If the service uses a combination of a connection microflow, a headers microflow, and a list of headers that specify the same header, the headers microflow overwrites the list value and the connection microflow overwrites both.
88
98
89
-
If the service uses a combination of a connection microflow, a headers microflow and a list of header that specify the same header, then the headers microflow overwrites the value of the list and the connection microflow overwrites both of their values.
99
+
#### Connection and Headers Microflow {#connection-and-headers-microflow}
100
+
101
+
Choose a microflow that returns one of the following options:
102
+
103
+
- A **System.ConsumedODataConfiguration** object with associated **System.HttpHeader** objects (for **Configuration microflow**)
104
+
- A list of **System.HttpHeader** objects (for **Headers microflow**)
105
+
106
+
This microflow can take a parameter of type **System.HttpResponse**. It is called every time a request is made. Initially, the HTTP response parameter is empty. If the service responds with `401 Unauthorized`, the microflow is called with that HTTP response and another request is made with the new HTTP headers.
107
+
108
+
{{% alert color="info" %}}
109
+
Custom authentication can be done with the microflow where the authentication value is retrieved (such as SSO). For more information on access and authentication, see [Using Custom HTTP Header Validation for Published Entities](/refguide/security-shared-datasets/#http-header-validation) in _Security and Shared Datasets_.
110
+
{{% /alert %}}
90
111
91
112
### Advanced
92
113
@@ -108,19 +129,6 @@ The microflow must return a `String` containing the error message. If it returns
108
129
109
130
Note for developers of Java actions: the message returned by the error handling microflow can be caught as a [UserException](https://apidocs.rnd.mendix.com/11/runtime/com/mendix/systemwideinterfaces/core/UserException.html).
110
131
111
-
### Connection microflow and headers microflow{#connection-and-headers-microflow}
112
-
113
-
Choose a microflow that returns one of the following options:
114
-
115
-
- A **System.ConsumedODataConfiguration** object with associated **System.HttpHeader** objects (for **Configuration microflow**)
116
-
- A list of **System.HttpHeader** objects (for **Headers microflow**)
117
-
118
-
This microflow may take a parameter of type **System.HttpResponse**. The microflow is called every time a request is made. Initially, the HTTP response parameter will be empty. If the service responds with `401 Unauthorized`, the microflow is called with that HTTP response and another call is made with the new HTTP headers.
119
-
120
-
{{% alert color="info" %}}
121
-
Custom authentication can be done with the microflow where the authentication value is retrieved (such as SSO). For more information on access and authentication, see [Using Custom HTTP Header Validation for Published Entities](/refguide/security-shared-datasets/#http-header-validation) in _Security and Shared Datasets_.
122
-
{{% /alert %}}
123
-
124
132
#### Authenticating with Mendix SSO {#authenticate-mendix-sso}
0 commit comments