OutSystems User Group KL event. 24th August, 2021

1. Welcome to KL
OSUG!
Clean Low-Code &
Use Case
Tuesday, 24th August 2021
8:00 PM - 9:30 PM (+8 GMT)

2. 2
Learn, ask questions, access reusable apps,
share ideas, and connect with other
OutSystems developers around the world.
Bookmark outsystems.com/community
usergroups.outsystems.com
outsyste.ms/champions
outsyste.ms/mvp
OutSystems Community

3. Today’s Host
Nadzir Yahaya
Software Development Manager
EASS Sdn Bhd

4. Rules of
Engagement
🔇 - Please remain on mute during presentations
📷 - Video cameras are welcomed!
🙋 - Have a question/comment? Drop it in the Q&A!
💻- Let us know where you’re dialing from in the chat!
⏺⏺
- This meeting will be recorded and shared via email &
in User Groups
📝 - Want to provide feedback? You will receive an email
with link to provide your feedback at the end
4

5. 5
● Clean Low-Code
● Zer0hunger Digital Samaritan
● Networking & Games
Agenda

6. Clean Low-Code
Best practices in writing and drawing clean low-
code by Uncle Hasan
Hasan Derawan
Tech Lead @ Do iT Lean | OutSystems Champion

7. 7
1. What is Clean Code?
2. Clean Architecture
3. Naming Conventions
4. Controls Best Practices
5. Drawing
6. Q & A
What we’ll learn

8. What is Clean Code?
8

9. The most accurate
definition of clean code
9
We need to talk… — said the Tech Lead.

10. 10
Clean Code Principles
Elegance Simple & Direct Literate Care
Clean code does one
thing well.
Clean code is simple and
direct.
Clean code can be read,
and enhanced by other
developers.
Clean code always looks
like it was written by
someone who cares.
Making the life of developers easier
image: Flaticon.com

11. Clean Architecture
11

12. Modules / Applications Layers
12

13. No Violations
13

14. Naming Conventions
14

15. Modules
● Foundation
_Lib
_IS
_Th
_Pat
● Core
_CS
_BL
_CW
_Sync
_API 15

16. Code Structure
● CRUDs folder contains the
public access for entities.
● [Entity] folder contains the
wrappers, to fill the
created/updated date/user
fields, do basic validation,
and trigger some other
actions (e.g. auditing).
● Have a separate folder for
Access Control actions.
16

17. Elements (Actions, Nodes, Parameters)
● Meaningful names.
● Use PascalCase.
● Suffix foreign keys with “Id” (e.g. “ProductId”).
● Use small letters dash separated words for css class names.
● Avoid empty labels and descriptions.
● Set the example string of Expressions.
● Pick One Word Per Concept (“get”, “fetch”, “retrieve”).
17

18. Elements (Actions, Nodes, Parameters)
18

19. Elements (Actions, Nodes, Parameters)
19

20. Controls Best
Practices
20

21. Actions
● Should do one job only.
● Should be small (~10 nodes in the main flow).
● Should have few arguments.
● Better to have one output parameter.
● Have no side effects
● Don’t leave commented code.
● Add comment only in the complex/long flows.
● Use TODO and DO it.
● Remove unused dependencies.
● Better to have an assignment node for each assignment of
different nature of logic. 21

22. Screens
● Group screens into UI flows.
● Don’t put the style at the level of widgets. Use class instead.
● Use Button Loading instead of normal Button.
● Use “If” widget instead of the “Visible” property to hide/show
content.
● Use icons for custom widgets or components.
22

23. Aggregates
● Specify the “Max. Records” when you use aggregates to return
only one record, or when you use it in a condition to check if the
result is empty.
● Use aggregates instead of SQL node.
● Call aggregates directly at the screen level (Avoid wrapping
aggregates in actions to use it in screen).
● Avoid using aggregates inside loops. Instead, use the aggregate
before the loop and use the filter action inside the loop to filter
the data.
● Define a custom structure for the SQL output.
23

24. Security
● Add a role check in every public action.
● Avoid anonymous screens.
● Has separate roles for each application.
● Define reusable client actions to check the role in JS node.
24

25. Drawing
25
From Leonardo Fernandes article on Medium

26. Down is progress
26

27. Down is progress
27

28. Branch to the right
28

29. Cycles start on a diagonal
29

30. Avoid overlapping arrows
30

31. Align with intent
31

32. zzzzzzz
You need to be
happy?
Don’t Repeat Yourself.
Remove the duplication by reusing actions and
blocks.

33. References ● success.outsystems.com/Documentation/Best_Pr
actices
● outsystems.com/training/courses/193/
designing-apps-using-an-architecture-
framework/?LearningPathId=8
● leonardo-monteiro-fernandes.medium.com/a-
code-style-guide-for-outsystems-97a923084159
● itnext.io/clean-code-in-outsystems-570eaa78d1b2
33

34. Any Questions?
Hasan Derawan
hasanderawan@gmail.com
linkedin.com/in/hasan-derawan/
34

35. Zer0hunger Digital
Samaritan
A solution to connect people who wanted to
help those that need help
By:
Sharizal Shaarani - Director CoFounder @ Zer0hunger
Aaron Holesgrove - Engagement Manager @ PhoenixDX
John Salamat - Technical Lead @ PhoenixDX
Tom Good - OutSystems Developer @ PhoenixDX

36. Quiz Time!
36

37. FB: OutSystems User
Group Kuala Lumpur
37