Skip to content

Commit c84dd04

Browse files
authored
Merge pull request mendix#7405 from mendix/qt-integrationproofread
Integration how-to proofread
2 parents 82b0a70 + 81e6cee commit c84dd04

File tree

5 files changed

+50
-50
lines changed

5 files changed

+50
-50
lines changed

content/en/docs/howto/integration/export-xml-documents.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This how-to teaches you how to do the following:
1818

1919
## 2 Prerequisites
2020

21-
Before you can start exporting XML documents, you need data in your application that is used during the export. You first need to set up the data structure and GUI to maintain the customer data. Then you'll create the actual export logic and the corresponding export mapping. So, you need to know how to do the following:
21+
Before you can start exporting XML documents, you need data in your application that is used during the export. You first need to set up the data structure and GUI to maintain the customer data. Then, you'll create the actual export logic and the corresponding export mapping. To do this, you need to know how to do the following:
2222

2323
* Create a domain model (for more information, see [Configuring a Domain Model](/refguide/configuring-a-domain-model/))
2424
* Create a custom file document (for more information, see [File Manager](/refguide/file-manager/))
@@ -80,7 +80,7 @@ The XML schema describes what the contents of an XML document should be. We need
8080

8181
{{< figure src="/attachments/howto/integration/export-xml-documents/18581809.png" >}}
8282

83-
The mapping editor for this element will pop up, you can close that by clicking **OK**.
83+
The mapping editor for this element will pop up which can be closed by clicking **OK**.
8484

8585
6. Drag the **Customer** entity from the **Connector** into the placeholder:
8686

@@ -91,9 +91,9 @@ The XML schema describes what the contents of an XML document should be. We need
9191
{{< figure src="/attachments/howto/integration/export-xml-documents/18581806.png" >}}
9292

9393
7. In the mapping editor, verify the following:<br />
94-
1. **Method** is set to **By association**<br />
95-
2. **Association to parent** is set to **XMLDocument_Customer**<br />
96-
8. Select attributes for all five **Attribute to value element mapping** instances (or click **Map attributes by name** to accomplish this). You should have the following mapping:
94+
* **Method** is set to **By association**<br />
95+
* **Association to parent** is set to **XMLDocument_Customer**<br />
96+
8. Select attributes for all five **Attribute to value element mapping** instances (or click **Map attributes by name**). You should have the following mapping:
9797

9898
{{< figure src="/attachments/howto/integration/export-xml-documents/18581807.png" >}}
9999

@@ -142,13 +142,13 @@ To create the export logic, follow these steps:
142142
{{< figure src="/attachments/howto/integration/export-xml-documents/18581801.png" >}}
143143

144144
12. In the **Edit Change Item** editor, do the following:
145-
* For the **Member** for the change item, select the **XMLDocument_Customer** reference:
146-
* For the **Value**, enter *$CustomerList*
145+
* For the **Member**, for the change item, select the **XMLDocument_Customer** reference:
146+
* For the **Value**, enter `$CustomerList`
147147

148148
{{< figure src="/attachments/howto/integration/export-xml-documents/18581825.png" >}}
149149

150150
13. Click **OK** to save the change item.
151-
14. Create a change item to set the **Name** attribute to: *'customers.xml'* (including the single quotation marks [']). The **Create Object** dialog box should now look like this:
151+
14. Create a change item to set the **Name** attribute to *'customers.xml'* (including the single quotation marks [']). The **Create Object** dialog box should now look like this:
152152

153153
{{< figure src="/attachments/howto/integration/export-xml-documents/create-object.png" >}}
154154

content/en/docs/howto/integration/exposing-data-to-bi-tools-using-odata.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ tags: ["expose", "bi tools", "odata", "integration", "reporting tools", "excel",
1111

1212
Mendix apps encourage the application of a services-oriented architecture, with multiple smaller services providing APIs and user interfaces for a specific set of data and logic. Enterprises build up complete solutions by assembling these services.
1313

14-
One important aspect of services is that all access to data and logic is handled by the service operations. Direct access to databases used for storing the service data is discouraged, because this would bypass the business rules and security handled by the service. This creates a challenge for generic reporting, data warehousing, and ETL tooling.
14+
One important aspect of services is that all access to data and logic is handled by the service operations. Direct access to databases used for storing the service data is discouraged because this would bypass the business rules and security handled by the service. This creates a challenge for generic reporting, data warehousing, and ETL tooling.
1515

16-
The OData standard is being adopted because it enables generic data access within a services-oriented architecture. [OData](http://www.odata.org) is “an open protocol to allow the creation and consumption of queryable and interoperable Restful APIs in a simple and standard way.". In other words, it enables tools to use any REST/OData service by providing metadata that describes the data being provided, and by standardizing the messages exchanged with the OData services.
16+
The OData standard is being adopted because it enables generic data access within a services-oriented architecture. [OData](http://www.odata.org) is “an open protocol to allow the creation and consumption of queryable and interoperable RESTful APIs in a simple and standard way.". In other words, it enables tools to use any REST/OData service by providing metadata that describes the data being provided, and by standardizing the messages exchanged with the OData services.
1717

1818
A reporting tool like Excel or Tableau can discover what data and functionality is available in an OData service, and provide a generic way for users to build new queries for the data.
1919

20-
**This guide will outline how to do the following:**
20+
This how-to outlines how to do the following:
2121

2222
* Create a published OData service with resources
2323
* Add the OData server to Tableau and Excel
@@ -26,10 +26,10 @@ A reporting tool like Excel or Tableau can discover what data and functionality
2626

2727
## 2 Prerequisites
2828

29-
Before checking out this guide, make sure you do the following:
29+
Before reviewing this guide, make sure you do the following:
3030

31-
* Create an app that includes data you want to expose. You can either have published OData services already, or follow the steps in the [Creating a Published OData Service](#create-service) section below. For detailed steps to publishing an OData service,see the [Creating an App](/howto/integration/share-data/#createapp) and [Publishing to the Catalog](/howto/integration/share-data/#publishing) sections of *Share Data Between Apps*.
32-
* Install Excel (we will use Excel for Office 365).
31+
* Create an app that includes data you want to expose. You can either have published OData services already, or follow the steps in the [Creating a Published OData Service](#create-service) section below. For detailed steps to publishing an OData service, see the [Creating an App](/howto/integration/share-data/#createapp) and [Publishing to the Catalog](/howto/integration/share-data/#publishing) sections of *Share Data Between Apps*.
32+
* Install Excel (this document uses Excel for Office 365).
3333
* Download and install the public version of [Tableau](https://public.tableau.com).
3434

3535
## 3 Creating a Published OData Service {#create-service}
@@ -42,7 +42,7 @@ A published OData service can be used by third-party applications to read data f
4242
4. Under **Entities**, click **Add**:
4343
5. In the **Select Persistable Entity** window, select the entity you want to expose and click **Select**.
4444

45-
{{% alert color="info" %}}Security in OData is managed by the **App Security** settings and the entity-level access rules; therefore, if you have already configured access rules in your app, you do not have to configure security separately for OData.{{% /alert %}}
45+
{{% alert color="info" %}}Security in OData is managed by the **App Security** settings and the entity-level access rules. If you have already configured access rules in your app, you do not have to configure security separately for OData.{{% /alert %}}
4646

4747
6. On the **Settings** tab, choose **As an associated id** for **Associations**. Excel can handle the setting **As a link**, but Tableau does not support it.
4848
7. Start the application.
@@ -53,8 +53,8 @@ The OData service is now ready to be consumed.
5353

5454
1. Open Excel.
5555
2. Open the **DATA** tab and select **Get Data** > **From Other Sources** > **From OData Feed**.
56-
3. Retun to Studio Pro, and double-click the published OData service. Copy the link in the **Location** field to the clipboard.
57-
4. Back in Excel, on the **OData Feed** dialog box, enter the copied link for the **URL** and Click **OK**:
56+
3. Return to Studio Pro and double-click the published OData service. Copy the link in the **Location** field to the clipboard.
57+
4. Back in Excel, on the **OData Feed** dialog box, enter the copied link for the **URL** and click **OK**.
5858
5. Select the name of the published entity in the Navigator and click **Load**.
5959

6060
The data of the Mendix application is now available in Excel.
@@ -65,14 +65,14 @@ In this section, we will outline the steps for adding more than one published en
6565

6666
### 5.1 Use Case
6767

68-
Imagine that you have an app that helps with asset management. You have a Published OData Service with persistable entities called **SmartTask** and **Employee** that expose information. The domain model looks like this:
68+
Imagine you have an app that helps with asset management. You have a Published OData Service with persistable entities called **SmartTask** and **Employee** that expose information. The domain model looks like this:
6969

7070
{{< figure src="/attachments/howto/integration/exposing-data-to-bi-tools-using-odata/asset-manager-domain-model.png" >}}
7171

7272
To visualize data from your app in Tableau, follow these steps:
7373

7474
1. Open **Tableau** and select **Connect** > **To a Server** > **OData**:
75-
2. Return to Studio Pro, and double-click the published OData service. Copy the link the **Location** field to the clipboard.
75+
2. Return to Studio Pro and double-click the published OData service. Copy the link in the **Location** field to the clipboard.
7676
3. On the **Server Connection** dialog box, enter the copied OData service **Location** link for the **Server** address:
7777

7878
{{< figure src="/attachments/howto/integration/exposing-data-to-bi-tools-using-odata/18582020.png" >}}
@@ -81,16 +81,16 @@ To visualize data from your app in Tableau, follow these steps:
8181

8282
4. Click **Sign In** to save the server connection. You should now see the data source details.
8383
5. Click the name of the server connection and change it to a name related to your entity (in this case, **SmartTasks**) for readability.
84-
6. Click **Data** > **New Data Source** and repeat step 1–5 to add a server connection for other published OData services.
84+
6. Click **Data** > **New Data Source** and repeat steps 1–5 to add a server connection for other published OData services.
8585
7. Open **Sheet1**. Under **Data**, click the first entity and drag a desired entity **Attribute** from **Measures** to **Dimensions**. In this case, click **Engineers** and drag **ID** from **Measures** to **Dimensions**:
8686

8787
{{< figure src="/attachments/howto/integration/exposing-data-to-bi-tools-using-odata/18582012.png" >}}
8888

8989
8. Similarly, click and drag an attribute from the second entity from **Measures** to **Dimensions**. In this case, click **SmartTasks** and drag **SmartTask_Engineer** from **Measures** to **Dimensions**.
9090
9. Go to **Data** > **Edit Relationships...** to define the relationship between the different data sources.
9191
10. On the **Relationships** window, do the following:<br />
92-
1. Select your first entity for the **Primary data source**. In our imagined scenario, that is **SmartTasks**.<br />
93-
2. Select your second entity for the **Secondary data source**. In our imagined scenario, that is **Engineers**.<br />
92+
1. Select your first entity for the **Primary data source**. In this scenario, that is **SmartTasks**.<br />
93+
2. Select your second entity for the **Secondary data source**. In this scenario, that is **Engineers**.<br />
9494
3. Switch to **Custom** mapping.<br />
9595
4. Remove any default mappings.<br />
9696
5. Click **Add...** to configure a field mapping.
@@ -119,13 +119,13 @@ You should now see a bar chart of the data.
119119

120120
## 6 Filtering Data With Query Parameters
121121

122-
By default, all data is retrieved by Tableau, but Mendix allows you to add filters to the query so only the desired data is being retrieved.
122+
By default, all data is retrieved by Tableau, but Studio Pro allows you to add filters to the query so only the desired data is being retrieved.
123123

124124
To filter data with query parameters, follow these steps:
125125

126126
1. Right-click a data source and select **Edit Data Source...**.
127127
2. Click the OData URL to change the connection settings.
128-
3. Add *?$top=2* to the server URL (in order to only retrieve the first two values, engineers in this case) and click **Sign In**:
128+
3. Add `?$top=2` to the server URL (in order to only retrieve the first two values) and click **Sign In**:
129129

130130
{{< figure src="/attachments/howto/integration/exposing-data-to-bi-tools-using-odata/18581998.png" >}}
131131

content/en/docs/howto/integration/importing-xml-documents.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags: ["import", "xml", "integration"]
99

1010
## 1 Introduction
1111

12-
Mendix is the app platform for the enterprise organization, and in enterprise software, you likely do not work in a [green field](https://en.wikipedia.org/wiki/Greenfield_project). In almost every situation, you will need to integrate with existing systems. Mendix supports many ways of integration, but this how-to focuses on how you can import XML documents with Mendix.
12+
Mendix is the app platform for the enterprise organization, and in enterprise software, you likely do not work in a [greenfield](https://en.wikipedia.org/wiki/Greenfield_project). In almost every situation, you will need to integrate with existing systems. Mendix supports many ways of integration, but this how-to focuses on how you can import XML documents with Mendix.
1313

1414
This how-to teaches you how to do the following:
1515

@@ -28,7 +28,7 @@ Before you continue, make sure that you know how to create:
2828

2929
## 3 Preparing the Data Structure and GUI
3030

31-
The XML document used in this how-to contains customers. To be able to see the imported data, you first need to set up the data structure and GUI to maintain the customer data. Then, you need to facilitate the uploading and downloading of XML documents. Finally, you will create the actual import logic and the corresponding import mapping.
31+
The XML document used in this how-to contains customers. To see the imported data, you first need to set up the data structure and GUI to maintain the customer data. Then, you need to facilitate the uploading and downloading of XML documents. Finally, you will create the actual import logic and the corresponding import mapping.
3232

3333
To prepare the data structure and the GUI, follow these steps:
3434

@@ -38,21 +38,21 @@ To prepare the data structure and the GUI, follow these steps:
3838

3939
2. Create the overview and detail pages to manage objects of the **Customer** type.
4040
3. Create a menu item to access the customer overview page.
41-
4. Create an entity called **XMLDocument** that inherits all the properties from **System.FileDocument**:
41+
4. Create an entity called *XMLDocument* that inherits all the properties from **System.FileDocument**:
4242

4343
{{< figure src="/attachments/howto/integration/export-xml-documents/18581650.png" >}}
4444

4545
5. Create the overview and detail pages to manage objects of the **XMLDocument** type.
46-
6. Create a menu item to access the XML document overview page (for more information, see [Setting Up Navigation](/refguide/setting-up-the-navigation-structure/).
46+
6. Create a menu item to access the XML document overview page (for more information, see [Setting Up Navigation](/refguide/setting-up-the-navigation-structure/)).
4747

4848
## 4 Adding an XML Schema (XSD)
4949

50-
Whether you plan to import or export documents, working with XML means that your application must contain an XML schema, which is also called an XSD. An XSD describes the possible contents of an XML file. Based on the XSD, your application knows how to read or write an XML file. If you don't have an XSD file, there are some online XSD generators that accept an XML document as input. For this how-to, you can use [Customers.xsd](/attachments/howto/integration/importing-xml-documents/18581652.xsd).
50+
Whether you plan to import or export documents, working with XML means your application must contain an XML schema, which is also called an XSD. An XSD describes the possible contents of an XML file. Based on the XSD, your application knows how to read or write an XML file. If you don't have an XSD file, there are some online XSD generators that accept an XML document as input. For this how-to, you can use [Customers.xsd](/attachments/howto/integration/importing-xml-documents/18581652.xsd).
5151

5252
To add an XML schema (XSD), follow these steps:
5353

5454
1. Right-click a module in the **App Explorer** and select **Add Other** > **XML schema** from the menu.
55-
2. Enter **CustomersXSD** as the **Name** and click **OK**:
55+
2. Enter *CustomersXSD* as the **Name** and click **OK**:
5656

5757
{{< figure src="/attachments/howto/integration/export-xml-documents/18581696.png" >}}
5858

@@ -69,7 +69,7 @@ The XML schema describes what the possible contents of an XML file are, but we n
6969
To create the XML-to-domain mapping, follow these steps:
7070

7171
1. Right-click a module in the **App Explorer** and select **Add Other** > **Import mapping**.
72-
2. Enter **ImportCustomersMapping** as the **Name** and click **OK.** The new mapping will open automatically and the elements will be shown.
72+
2. Enter *ImportCustomersMapping* as the **Name** and click **OK**. The new mapping will open automatically and the elements will be shown.
7373

7474
{{< figure src="/attachments/howto/integration/importing-xml-documents/18581689.png" >}}
7575

@@ -83,7 +83,7 @@ To create the XML-to-domain mapping, follow these steps:
8383
{{< figure src="/attachments/howto/integration/importing-xml-documents/18581655.png" >}}
8484

8585
6. Open the connector (from the lower-right side of Studio Pro or from the **View** menu).
86-
7. Drag the entity **Customer** from the connector into the place-holder in the mapping editor:
86+
7. Drag the entity **Customer** from the connector into the placeholder in the mapping editor:
8787

8888
{{< figure src="/attachments/howto/integration/importing-xml-documents/18581681.png" >}}
8989

@@ -117,7 +117,7 @@ To create the import logic, follow these steps:
117117

118118
3. Double-click the new button to open the **Edit Action Button** editor and do the following:<br />
119119
1. Change the caption to *Import XML Document*<br />
120-
2. For the **On click** event, select **Call a microflow**, then click **Select** for the microflow, create a new microflow, and name it **XMLDocument_Import**.<br />
120+
2. For the **On click** event, select **Call a microflow**, then click **Select** for the microflow, create a new microflow, and name it *XMLDocument_Import*.<br />
121121
3. Click **OK** to save the properties.<br />
122122

123123
{{< figure src="/attachments/howto/integration/importing-xml-documents/18581646.png" >}}

0 commit comments

Comments
 (0)