Forem: MendixWithMe

How to install Event Broker Tools | Mendix 10

MendixWithMe — Tue, 05 Sep 2023 22:53:19 +0000

"Event Broker" is a mechanism that enables communication and the flow of events between different parts of an application or between different microservices in an event-driven architecture.
It plays a crucial role in building scalable and flexible applications, allowing different parts of the application to respond to events and interact with each other asynchronously.

Prerequisites to this tutorial

Git Installed https://git-scm.com/downloads

Attention!

In order to be able to follow this tutorial, it is recommended to do the tutorial regarding Business Events first.
https://medium.com/@mendixwithme/how-to-use-business-events-mendix-10-219ca7759514

Step by Step

1º Install Visual Studio Code and Docker.
VSCode: https://code.visualstudio.com/download
Docker: https://www.docker.com/products/docker-desktop/

2º Access "Event Broker Tools" page on Github and clone the repository by clicking on the "Code" button and copying the HTTPS link.
Github: https://github.com/mendix/event-broker-tools
Open a Git terminal inside the Mendix Folder and write "git clone https://github.com/mendix/event-broker-tools.git". Press Enter and wait.

3º Open the Visual Studio Code.

4º Select the Extension tab on the Side Menu and Search for "Docker". Select and install the Extension created by Microsoft.

5º After install, restart the VSCode and Open the folder with the cloned repository.

6º On the right side, go to the "local-setup" folder and right click on the "docker-compose.yml" file. Select the "Compose Up" option.

7º Go to BusinessEvents3 project (Check BusinessEvents tutorial if you don't have this project) and click on "Settings". Create a new configuration.

8º As a Name, write "BusinessEventLocalTest". Under the tab "Constants", add two new constants:
Name: BusinessEvents.ChannelName
Value: 'local'
Name: BusinessEvents.ServerUrl
Value: 'localhost:9092' (Windows) or
'YOUR-IPADDRESS:9094' (Linux/MACOS)

9º Click to "Activate" the new configuration. Run the project locally.

10º Do the same to the second app. Go to BusinessEvents4 project and click on "Settings". Create a new configuration.

11º Write "BusinessEventLocalTest" and under the tab "Server" change the "Runtime port" to "8081" and "Admin port" to "8091". We are changing this to be possible to execute both application at the same time.

12º Add two new constants:
Name: BusinessEvents.ChannelName
Value: 'local'
Name: BusinessEvents.ServerUrl
Value: 'localhost:9092' (Windows) or
'YOUR-IPADDRESS:9094' (Linux/MACOS)
It is important to check if your new configuration is active.

13º Run the project.

14º Inside the VSCode, confirm if all the topics have "Created" or "Started" after it.

15º Create a new Order object, selecting "Pending" as the order status.
Create a new Shipping object with the same status.

16º Go back to the first application and change the "order status" to "Cancelled". Return to the Shipping app and refresh the page. If everything went well, you should the "Shipping Status" as "Cancelled"

This is the end of the tutorial.
I'm creating a mendix community on discord to make life easier for devs. You can ask questions, help other people and have access to all the tutorials.
If you want to be part of this community, you can do so through this invite.
Discord: https://discord.gg/YHre8dXz3q

From the writer
If you enjoyed this article you can find more on our Medium page. For great videos, you can visit our Youtube page.
Are you interested in getting more involved with our community? Join us in our Discord Community Channel.

How to use Business Events | Mendix 10

MendixWithMe — Tue, 05 Sep 2023 22:40:36 +0000

Mendix Business Events enable applications to announce important occurrences and choose to receive such updates independently. Unlike direct communication methods like REST or Web Services, Business Events facilitate event notifications between apps without direct app-to-app interaction.
In this blog post, I will teach you how to use Business Events in Mendix!

Step by Step

1º To make this tutorial more accessible, we'll use the learning path projects "Create a Business Event Service in Studio Pro".
The first project is located on the 3.1.1 section called "Get Ready for the First App: Order Management".
Click on "Starter app - OrderManagement" to download

2º Download the second project on the 4.1.1 section called "Get Ready for the Second App: OrderFulfillment"
Click on "Starter app - OrderFulfillment" to download

3º Open an instance of Mendix Studio Pro and click in "Import App Package". Select the file regarding the first project with the name "Business Events-V10-L3.1.1"

4º Choose "New Mendix Team Server" and change the App Name to "BusinessEvents3"

5º After load the project, right click on the "OrderManagement"
module, go to "Add other" and click on "Business event service"

6º Select "Create a new business event service" and change the Document name to "BE_OrderStatusUpdateService"

7º Click "Add" under the tab "Business event definitions"

8º As a business event write "OrderCancelled"

9º Add a new attribute

10º Write as a Name "OrderID" and select "Integer" as a Type

11º On the step 2, under the tab "Other apps can" select the checkbox "Subscribe to events"

12º Go to the domain model and check if an entity was created. If yes, all went well.

13º Inside the folder "OverviewPages", click on the "Order_NewEdit" page

14º Right click on the "Save" button and click to go to the microflow

15º Drag and drop a retrieve action to the microflow and fill the options with the following information:
Source: From Database
Range: First
XPath: [OrderID = $Order/OrderID]
Object Name: OrderBeforeChange

16º After the close page action, add a decision and write as a caption "OrderStatus changed to Cancelled".
For the expression:
"$Order/OrderStatus != $OrderBeforeChange/OrderStatus
and
$Order/OrderStatus = OrderManagement.OrderStatus.Cancelled"

17º Following the happy way, add a "Create Object" action.
Select as a Entity "OrderCancelled" and add the attribute "OrderID" with the value "$Order/OrderID"

18º On the toolbox search for "Publish business event" and add to your microflow. Double click on the action and as a Subject write "An order is cancelled". Fill the Business event with the value "$NewOrderCancelled".

19º Before the end event, add an "Log Message" activity.
Log Level: Info
Log node name: 'OrderManagement"
Template: {1}.{2} is created at {3}
Parameters: {1} - $NewOrderCancelled/ServiceName
{2} - $NewOrderCancelled/EventName
{3} -toString($NewOrderCancelled/createdDate)

20º Check if your final microflow is similiar to the one on image below.

21º Go back to the Business Event and click on the button "Export AsyncAPI Document"

22º Click in the button "Publish" on the top of Studio Pro

23º Open a new instance of Studio Pro and Import a new app Package.
Click on the "Business events - V10 - L4.1.1" file. Create the project with the name "Businessevents4"

24º Right click on the module "OrderFulfillment" -> Add Other -> Business event service.

25º Select "Use an existing business event service". As a Document name write "BE_OrderStatusUpdateService" and choose the yaml file that we just downloaded.

26º Under the tab Subscribe, click in "Add"

27º To the business event, select the "OrderCancelled".
Business event entity: "CBE_OrderCancelled"
Handler Microflow: "HandleBE_OrderCancelled"
After click "ok", check on the domain model if the entity was created.

28º Go to the "HandleBE_OrderCancelled" microflow. Add a retrieve action with the following properties.

29º Add a Change Object activity. Select as a Object the retrieved object "Shipping". Change the "ShippingStatus" and fill with the value "OrderFulfillment.ShippingStatus.Cancelled"

30º Click to "Publish" the app.

31º Click in View App in both projects to see them on the browser

32º On the Manage Customer Orders project, click in new to create a new object.
Order date: Select any date
Total amount: Any amount
Order Status: "Pending" (Can't be "Cancelled")

33º Go to Shipping app and also create a new object.
Order ID: Should be the same number of the object created on the Order app
Carrier: Any Carrier
Actual Delivery date: Select any date
Shipping Cost: Any Amount
Shipping Status: "Pending" (Can't be "Cancelled")

34º Return to Manage Customer Orders project and select the object created. Change the "Order Status" to "Cancelled" and Save.

35º Go to the Shipping app and refresh the page. If everything went well, the Shipping Status should be "Cancelled"

How to consume a REST API | Mendix 10

MendixWithMe — Tue, 22 Aug 2023 12:03:22 +0000

API consumption is common in high-level or low-code programming. In this blog post, I will teach you how to Consume a REST API in Mendix!

Prerequisites to this tutorial

Have a RapidAPI account https://rapidapi.com/hub

Step by Step

1º Let's start by entering the website https://rapidapi.com/martin.svoboda/api/quotes15

2º Click on the button "Test Endpoint" and see the answer on the "Results" tab.

3º Click on the "Example Responses" tab and press the button "Copy"

4º In Studio, go to your module and right click on it. Select "Add other" and choose "JSON Structure". As a name write "JSON_Quotes".

5º Paste the JSON structure you copied before and click on "Refresh"

6º On the Structure, scroll to the right and change the "Custom Name" of the first object from "Root" to "Quote".

7º Go to your module, right click on it and select "Add other" then choose "Import Mapping". For the name write "IMP_Quotes"

8º To the schema source, select "JSON structure" and choose "JSON_Quotes"

9º Check the following attributes: "language_code", "content", "url" and "name"

10º Click in "Map automatically"

11º Create a blank new page with the name "Quotes_Overview"

12º Inside the page, add a data view and as a "data source", select Microflow. Create a new microflow with the following name: "DS_Quotes_GetData"

13º In the microflow, drag and drop a "REST Call service" action.

14º Double click on the action, press edit near the Location input. In "template" paste the url of the service. You can find it under the tab "Code Snippets" with the key "url".

15º Change to the "HTTP Headers" tab and press the button "New" under "Custom HTTP Headers" subtitle.

16º Create 2 HTTP Headers.
First Header:
- Key: X-RapidAPI-Host
- Value: 'quotes15.p.rapidapi.com'
Second Header:
- Key: X-RapidAPI-Key
- Value: 'Your API Key'

To get your API Key go to your profile by click on your avatar on the top right of the page -> Personal Billing -> My Apps (Left Side Menu) -> default-application -> Authorization.
If you dont have any Authorization, create one by clicking on the button "Add authorization".

17º Implement an error handling by right clicking in the "Call REST Service" action and selecting "Set error handling". A popup will open and give 3 options to select. In our case, we are going to select "Custom without rollback".

18º Add an "end event" action below the "Call REST service" activity. Between both, add a "Show Message" action. Select as "Type" the value "Warning" and as template write "{1}" to be possible to define a parameter.
Click in new parameter and insert as a value "$lastestError/Message".

19º Return to the "Call REST service" activity, click in the tab "Response" and for the "Response handling" choose "Apply import mapping". Select the import mapping that we created before "IMP_Quotes" and store in a variable with the name "Quote"

20º Right click on the REST Service and select "Set $Quote as return value". Go to the "end event" below and set the value as "empty".

21º Give access permission to the microflow "DS_Quotes_GetData" and to the page "Quotes_Overview".

22º On the page "Quotes_Overview", add text inputs for "Quote" entity attributes

23º Go to the project navigation and add the "Quotes_Overview" page to the menu.

24º Inside the domain mode, double click on the "Quote" entity. Select access rules and create a new one. Choose the module role "User" and give "Read, Write" access to the attributes and permission to create and delete an object.

25º Run the project and test the REST call by clicking on the Quotes page.

How to Export Excel File/Report with Excel Exporter - Mendix 10

MendixWithMe — Tue, 15 Aug 2023 14:09:33 +0000

The need to export excel files is something common in the day to day of a business. In this blog post, I will teach you how to export excel files using Excel Exporter module.

Prerequisites Marketplace modules

Mx Model Reflection Before starting the tutorial, make sure that you have the Mx Model Reflection module installed in your project. If you don't have it, you can install it using the following link. https://marketplace.mendix.com/link/component/69

Step by Step

1 - Download the module Excel Exporter from the marketplace.

2 - Insert page "Excel_Document_Overview" into navigation (and MxObjects_Overview from Model Reflection if you don't have it yet)

3 - Create a new project module called ExcelExport

4 - Double click on the module security and create a new module role called "Admin"

5 - Go to application security, select admin and click in Edit roles. Give admin access to this role

6 - In ExcelExport module, create ExcelDocument Entity as a Generalization of FileDocument

7 - Select Access Rules tab and give permissions to the user role "Admin".

8 - Create another entity called ProjectExport with the same attributes of the entity that you want to export the data.

9 - Select Access Rules tab and give permissions to the user roles.

10 - Add an association between ExcelExport and ProjectExport. This association should be 1 to * (one to many)

11 - Double click on the association and select "Delete 'ProjectExport' object(s) as well" under "On Delete of 'ExcelDocument' object"

12 - Create a folder to each entity as such:

13 - Create a microflow called ACT_ProjectExport_ExportList inside the "ProjectExport/Microflows/ACT" folder

14 - Inside the microflow, add a retrieve action. Select as a source "From Database" and choose the entity "MxTemplate". As a constraint write "[Name = 'Projects']" (The "Projects" can be changed for what makes more sense in your own project)

15 - Add a decision to check if $MxTemplate is not empty ($MxTemplate != empty)

16 - Add a Create Object action. Select as Entity "ExcelDocument" from ExcelExport Module. Click in New and select "DeleteAfterDownload" attribute. Set the value as "true".

17 - Create a new list. As entity use "ProjectExport" from ExcelExport Module and change the list name to ProjectExportList.

18 - Add a new Retrieve action to the microflow with the entity from where you want to export the data. As an example we will select "Project".

19 - Now it is necessary to iterate throughout the list. To do so, add a Loop action and select the list we just retrieved.

20 - Inside the loop, add a new create object action. Select as a Entity "ProjectExport" from ExcelExport Module. Fill all the entity attributes with the data from the iterator.

21 - After the attributes values, fill the association with the ExcelDocument object.

22 - Add a change list action. Select "ProjectExportList" and use the object we just created as a value.

23 - Outside the loop, drag and drop a commit object action. Select the list called "ProjectExportList".

24 - Go to microflow properties and give access to the module role "admin".

25 - Save and go to the App Module -> Marketplace Modules -> XLSReport -> UseMe Folder and Select "GenerateReport" microflow.

26 - Right click on the microflow and click Duplicate. Right Click on the duplicated microflow and move to ExcelExport Module -> ExcelDocument/Microflows/SUB folder and rename it to SUB_ExcelDocument_GenerateReport

27 - Inside the microflow, delete the create CustomExcel action. Regarding the parameters, add a new with a data type object and with ExcelDocument as a entity.

28 - Double click on the java action "GenerateExcel". Change the inputs values to the following objects:
Template object: $Template
Output Document: $ExcelDocument
Input Object: $ExcelDocument

29 - Go to microflow properties and give access to the module role "admin".

30 - Go back to the ACT_ProjectExport_ExportList microflow and add at the end the SUB_ExcelDocument_GenerateReport. Double click on the SUB and fill the parameter values.

31 - In your overview page, add a new microflow button and select ACT_ProjectExport_ExportList microflow.
Change the caption to "Export" and the icon to the export icon.

32 - After running the project, click on the Model Reflection page located on the menu.

33 - Select "ExcelExport" and "XLSReport" Modules. Then, “Click to Refresh” in order to synchronise all entities and microflows.

34 - On the menu, click on Excel Exporter page and Select New button.

35 - Create a new template by filling the fields with the following values and click "Save and Next":
Document Type: Excel 2007 and higher
Filename: Projects
Input object: ExcelExport.ExcelDocument

36 - Select a date format for the "Date time export format" field

37 - In Worksheets, click in new and fill all the fields with the data that you see on the image below.

38 - Click on the "New" button inside the "Column data" tab. A popup will appear, in which we can fill in the column number, name and select the attribute we want to see exported. It is important that the first column has the number 0 instead of 1.

39 - Create all the columns you need for your export.

40 - Go back to the overview page and click on the "Export" button.
After the download is finished, you can open the file and all your projects will be available.

From the publisher
If you enjoyed this article you can find more on our Medium page. For great videos, you can visit our Youtube page.
Are you interested in getting more involved with our community? Join us in our Discord Community Channel.