OutSystems-Developer-Cheat-Sheet
Uploaded by
JALAL SAMAKOutSystems-Developer-Cheat-Sheet
Uploaded by
JALAL SAMAKeach Attribute’s Data Type in the properties panel (8)
OutSystems Developer Cheat Sheet ○ In[Logic] Layer , right-click either the[Client ● APrimary Keyof anEntity:
Actions]or[Server Actions] folder, and“Add ○ UnderEntity Identifiers, select the Entity Identifier
Client/Server Action” ● AStructurethe same as theAttributes (row) of an Entity:
Service Studio IDE 1. OR withScreen scope: ○ UnderEntities, select the Entity
○ In[Interface] Layer Elements Tab (7), right-click the ● AnexistingStructure, defined under the[Data] Layer :
creen , “Add Client Action”
S ○ UnderStructures, select the Structure
.An orange ballfor the Action will be created: Hollow orange
2 Define calculations with Operators/Operands/Functions in
an Action
for client-side (compiles to Javascript) and solid orange
for server-side (compiles to .NET). NOTE: This default
● In a conditional: UsingIf logic widget
icon can be changed from the properties panel (8).
○ In the properties panel (8) after selecting theIfwidget,
3.Right-clickon the newly created Client or Server double-click on theConditionproperty row to bring up
Action to add anyInput/Output ParametersorLocal theExpression Editorand type your expression in the
Variables Expression field using operands and operators, as well as
4.Double-Clickon the newly created Client or Server variables, functions, and scripts in scope as seen in the
Action to define the logic, by dragging/dropping Logic Scope pane (bottom left of Expression Editor)
widgets from the Toolbox (2) into the flow and setting their
properties (8) ● In an assignment: UsingAssign logic widget
5.NOTE: To make the Action also accessible in anexpression ○ In the properties panel (8) after selecting theAssign
( 1) 1-Click PublishButton - Compile and Run as a Function, set the Action’s “Function” property to “Yes” widget, select aVariableto assign the expression to, then
(2) Toolbox- Elements to drag onto Canvas Define Variables double-click on theValueproperty row to bring up the
(3) Canvasto design Processes/UI/Logic/Data Model ● WithMethod scope: Expression Editorand type your expression in the
(4) Widget Breadcrumb- Navigate through UI hierarchy Expression field using operands and operators, as well as
○ Right-click on theAction , “Add Local Variable”, variables, functions, and scripts in scope as seen in the
(5) Element Breadcrumb- Navigate through Elements and set its Data Type in the properties panel (8)
(6) LayersTab- Processes, Interface, Logic, Data Scope pane (bottom left of Expression Editor)
WithScreen scope:
● Define For Each and While loops in an Action
(7) Elementsfor selected Layer - Some elements can be
dragged onto Canvas;Widget TreeTab (Interface Layer ○ In[Interface] Layer Elements Tab (7), right-click the
only) to navigate hierarchy of UI Elements creen , “Add Local Variable”, and set its Data Type in
S ● For Each logic widget
(8) Propertiesfor selected Element(s);StylesTab the Properties panel (8) 1. In the properties panel (8) after selecting theFor Each
(Interface Layer only) for selected UI Elements WithSession scope(Cleared on End User log-off or
● widget, fill in theRecord Listproperty, and optionally the
(9) True ChangeandDebuggerTabs timeout) Start Index and Maximum Iterations properties.
2.Drag your mouse from theFor Eachwidget (cursor will
Define custom data structures ○ In[Data] Layer , right-click the[Client Variables]
folder, “Add Client Variable”, and set its Data Type in the t urn into crosshairs ) to drag out theCyclebranch to
1. In[Data] Layer , right-click the[Structures] folder, and properties panel (8) define the 1 or more logic widgets that will execute in this
“Add Structure” WithModule scope:
● loop.
2.Right-click on the newly created Structure, select “Add 3.Complete the loop by dragging from the last logic
○ In[Data] Layer , right-click the[Site Properties] element back to the If widget.
Attributes”, and set its properties (i.e. Data Type) in the
folder, “Add Site Property”, and set its Data Type in the 4.NOTE: You can create logic to exit the loop early by
properties panel (8).
properties panel (8) placing anIfwidget within the flow for the exit condition.
Create a Screen
Define Variables beyond Basic Data Types
● Method 1: In[Interface] Layer Elements Tab (7), In theData Typeproperty of the Variable, to define a Variable ● While: UsingIf logic widget
right-click the[MainFlow] UI Flow, and“Add Screen” of: 1. In the properties panel (8) after selecting theIfwidget, fill
● AnArray/List: in theConditionproperty.
● Method 2: In[Interface] Layer Elements Tab (7), ○ UnderOther, selectList…then select the List type 2.Drag your mouse from theIfwidget (cursor will turn into
double-click the[MainFlow] UI Flow,and drag a “Screen” ● A temporaryStructure:
widget from the Toolbox (2) ○ UnderOther, selectRecord…then right-click on the rosshairs
c ) to drag out theTruebranch to define the
Define a reusable Method (OutSystems term: “Action”) Variable and select “Add Attribute” to add other 1 or more logic widgets that will execute in this loop as
1. WithModule scope: Attributes of the Record/Structure as necessary, defining long as the If Condition property is true.
OutSystems Developer Cheat Sheet v0.8 Page1
3.Complete the loop by dragging from the last logic ethods” if you have access to a REST API with Swagger
m creen , “Fetch Data from Database” and define the
S
element back to theIfwidget. specification and want to consume multiple methods at Query in the Aggregate editor (see above)
● NOTE: You can swap the while loop to loop while theIf once - see documentation) From Action(asynchronously executed Method on page
●
condition is False by right-clicking on the If widget, and 2.Select theMethod(GET, POST, PUT, DELETE, PATCH), and load)
selecting “Swap connectors” paste theURL, replacing anyparametersinbraces(curly
● NOTE: You can create logic to exit the loop early by brackets) 1. In[Interface] Layer Elements Tab (7), right-click the
placing anIfwidget within the flow for the exit condition. 3.Depending on the Method selected, fill in theBodyTab Screen , “Fetch Data from Other Sources”
Call a Method/Action with sampleRequestand/orResponseJSON or 2.In the newly created Data Action, select the Output
NOTE: If calling from a UI element, first double-click on the UI text/plain example to allow the platform to generate the parameter and modify the properties (i.e. Data Type) as
element to edit the OnClick Action for that element. parameters and structures necessary, and define the Action logic to retrieve the data
● Drag any reusable Action into the Action logic flow ● NOTE: Under theTestTab, you can execute a test of to assign to the Output parameter.
the API Method (providing any required parameters) Display retrieved data on Screen (Basic)
○ From under the currentScreen in the[Interface]
and copy the request/response body to the Body Tab As an Expression:
●
Layer Elements Tab (7) 4.Under theHeaders and AuthenticationTab, you can
○ From under the[Client Actions]or[Server Actions] define any Request/Response headers, as well as any ○ In[Interface] Layer Elements Tab (7), double-click
REST API Authentication requirements t heScreen , and drag any Screen’sLocal Variable,
folderin the[Logic] Layer Data ActionOutput Variable, ScreenEntity, or any of
5.ClickFinish,and you should see a ServerAction for
○ “Run Client/Server Action” from the Logic widgets (2) theirattributesto the Screen.
the REST API you consumed that you can call from other
Define Database Tables and Relationships Actions ● In a Form Element (i.e. Input, Text Area, Switch, Checkbox,
● NOTE: For advanced pre-processing and etc):
1. In[Data] Layer , under the[Entities] folder, right-click
post-processing, you can define theOnBeforeRequest ○ Select the Form element widget, and configure the
[Database]forServer-Sideor[Local Storage]forMobile,
andOnAfterResponseActions that will execute for all Variable property to bind it to in the properties panel (8)
select “Add Entity” to define the Database Table
REST APIs under the REST API properties. ○ NOTE: It may require Data Conversion (see above)
2.Right-click the newly createdEntity , and select “Add
Expose a REST API
Entity Attribute” to define each Entity Attribute (column) in
the properties panel (8)
1. In[Logic] Layer , right-click REST under the
3.To define aForeign Keycolumn, set itsData Typein the
[Integrations] folder, “Expose REST API”, then right-click
properties panel to one of the “Entity Identifiers” OR name
the newly created REST API and select “Add REST API
the attribute to<EntityName>Idwhere OutSystems will
Method” for each API Method you want to define.
automatically assume it’s the Foreign Key to that Entity.
2.Defining each API Method is the same as defining a
Define a Query (SELECT) from a Database visually using
reusable Method/Action as per above instructions;
Aggregates
ouble-clickon the newly created Action
D to edit
1. In anAction , drag theAggregate widget it, add input/output parameters, local variables, call other
into the logic flow, then double-click on it to bring up the Actions, etc.
Aggregate editor ● NOTE: For every exposed REST API, the OutSystems
2.Drag anyEntitiesyou need for this query from the[Data] Platform will automatically generate Swagger
documentation that you can share with other developers
ayer
L onto the Aggregate editor. Each one will be added
(including non-OutSystems) who need to integrate with
to theSourceslist under theSourcesTabin the Aggregate
your exposed REST API. You can access this
editor, and any relationships will automatically appear under
documentation’s URL by right-clicking on the REST API
theJoinscolumn, which can also be customized. If a join
and selecting “Open Documentation”
needs to be manually added, click on “Add join”.
Data Conversions
3.Add anyFilters(WHERE) under theFiltersTab (May say “No
● In an Expression, you have access to the Functions listed
Filters”) in the Aggregate editor.
under theData Conversionfolder under theBuilt-in
4.Add anySorts(SORT BY) under theSortingTab (May say
Functionsfolder.
“No Sorts”) in the Aggregate editor.
Retrieve data for Screen
Consume a REST API
● From Aggregate(asynchronously executed SQL query on
1. In[Logic] Layer , right-click REST under the page load)
[Integrations] folder, “Consume REST API”, then select ○ In[Interface] Layer Elements Tab (7), right-click the
“A
dd single method” (You can select “Add multiple
OutSystems Developer Cheat Sheet v0.8 Page2
OutSystems Main Concepts Screen and Block Tools Input Send data into Action Method parameter
Paramete
he OutSystems Platform provides developers with a
T
Widget UI Controls UI Control Classes r
domain-specific language for developing and changing web
and mobile business applications. This developer cheat sheet Input Send data to a screen uery string variable
Q utput Return data from Action
O Methodoutparameter
describes the OutSystems language main concepts and their Paramete of an HTTP request, or Paramete
mappings to other development languages, including .NET. r anHttpContext Item r
Processes Layer in Server request ocal
L Variables with Action scope Method Local Variable
Business Processes and Batch Processing ocal
L Variables with Screen scopeInstance variable of Variable
OutSystems Description Traditional/.NET/Jav Variable the web page ser-Defi Actions that can be invoked StaticMethod
U
ascript etch
F Asynchronous Action that ned in Expressions
Process Integrate business Data fromretrieves data to the Client Function
processes into an Database using a Server-side Client Action Tools(Compiles toJavascripton the Client)
application by Aggregate
defining activities etch
F Asynchronous Action that Start Start of Action flow
within process flows Data fromretrieves data to the Client Message Pop-up an Alert message
Timer ctions that
A Batch job Other using a Server Action flow
un
R Call a Client-Side Method
execute Sources
Client
asynchronously on lient
C ctions only available in
A Action
a defined schedule. Action Screen; compiles to
un
R Call a Server-Side Method
Process Actions Javascript on screen
Server
Screen and Block Widgets Action
Launch<Process> xplicitly launch an
E ggregat SELECT Query, using visual
A
instance of a ContainerA “box” to contain other Panel e (Mobile)editor; for JOIN, WHERE,
process widgets and containers SORT BY, GROUP BY, etc; DB
Timer Actions If ontrol displayed content if/else
C agnostic (DB type is
based on condition(s) with abstracted away)
Wake<Timer> xplicitly wake a
E “then/else” efresh
R efreshes a Screen
R
Timer, ignoring its xpressio Render value computed at Label
E Data Aggregate to update the
schedule n run-time resultset for the Client
( See Table, List, List Item, Form, *Only available on Screen
Interface Layer Documen Label, Input, Text Area, Actions
ser Interface
U tation for Switch, Checkbox, Radio CommentAdd a comment
OutSyste Description raditional/.NET/Javasc
T Others) Group, Dropdown, Upload, If onditional for branching
C Ifstatement
ms ript Button, Button Group, Link, Action flow into 2 paths
UI Flow ser interaction diagram of N/A
U Popover Menu, Image, Icon,
Switch onditionals for branching S
C witch/c
ase/b
reak
screens Popup, Block, HTML
Action flow into multiple statement
Element, etc
UI Flow Tools paths
For Each R
epeats Action path Foreachstatement
Logic Layer
Screen HTML pages execution
usiness Logic
B
Block eusable group of widgets
R Assign ssigns 1 or more
A Series of=statements
OutSyste Description raditional/.NET/Javasc
T
for other blocks/screens expressions to 1 or more
ms ript
Email end an email
S variables
lient/SerBusiness Logic; Server
C Method
asynchronously via a SON
J onvert a Record or a List
C
ver Actions compile to .NET and
sending queue. Serialize of Records into JSON
Action run on the Server; Client
xternal C
E onnects to a site external data-interchange format
Actions compile to
Site to your module through a text.
Javascript and run on the
well-known URL you specify Client.
OutSystems Developer Cheat Sheet v0.8 Page3
SON
J Convert a JSON string into Assign ssigns 1 or more
A Series of=statements
Deserializ a Structure or List expressions to 1 or more ecurity
S
e variables OutSyste Description raditional/.NET/Javasc
T
xceptionHandle exceptions by
E Catchstatement with ecord
R xports contents of a
E ethod that writes a
M ms ript
Handler catching them and allowing catchblock List To record list to an Excel file list of objects into an Role Implement security ecurity setting
S
you to define a parallel error Excel Excel file using a representing a group of granted to users and
handling flow library to write Excel elements that share the roles
aise
R Explicitly launch a user Throwstatement files same grant policy
Exceptionexception xcel To Imports content of an Excel Method that reads a
E Role Actions
avascrip Add in in-line Javascript
J Record file into a record list list of objects from an
t code to execute List Excel file using a heck<RoChecks whether a specific N/A
C
library to read Excel le> End User has been granted
End nds the Action flow. More
E
files access to a specific
than one End element in
the same Action flow is SON
J onvert a Record or a List
C permission area
allowed for organization. Serialize of Records into JSON rant<Rol Provides access for a
G N/A
data-interchange format e> specific End User to a
estinati J
D umps to a specific screen
text. specific permission area.
on *Only available on Screen
Actions SON
J Convert a JSON string into evoke<R Denies access for a specific N/A
R
Deserializ a Structure or List ole> End User to a specific
DownloadDownload facility ethod that writes
M
e permission area.
*Only available on Screen the request response
Actions to a file, by setting the xceptionHandle exceptions by
E Catchstatement with
*Not on Mobile request content type, Handler catching them and allowing catchblock Data Layer
its header, and writing you to define a parallel error atabase (Server-Side) and Local Storage (Client-Side)
D
the file content to its handling flow OutSyste Description Traditional/.NET/Javasc
output stream, all aise
R Explicitly launch a user Throwstatement ms ript
processed on the Exceptionexception Entity ersistent data storage
P atabase Table, similar
D
Client side. CommentAdd a comment representing database toDataSourceor an
Server Action Tools(Compiles to.NETon the Server) end
S * Does not exist in Data model Object-Relational (OR)
Email Action Mapping Class
Start Start of Action flow End nds the Action flow. More
E ntity
E Entity storage atabase Table Field,
D
un
R Call a Server-Side Method than one End element in Attribute similar toDataSource
Server the same Action flow is field or a field in an
Action allowed for organization. Object-Relational (OR)
ggregat S
A ELECT Query, using visual Method with SQL Mapping Class
e editor; for JOIN, WHERE, query returning a I ntegrations
SORT BY, GROUP BY, etc; DB dataset OutSyste Description raditional/.NET/Javas
T
agnostic (DB type is ms cript ntity
E RUD (Create, Read, Update,OR Mapping CRUD
C
abstracted away) SOAP Expose/Consume SOAP API Actions Delete) Actions Methods or Methods
SQL ELECT Query, using
S ethod with SQL
M automatically created and that execute the
REST Expose/Consume REST API
DB-specific text-based query returning a managed by the CREATE,GET,UPDATE,
SAP Integrate with SAP BAPI OutSystems platform for andDELETESQL
SQL dataset
xtension Wrappers to existing C#
E Class Libraryproject each Entity statements
If onditional for branching
C Ifstatement
(.xif) libraries, database tables, compiled into a native tatic
S ntity with static data
E ntity with static and
E
Action flow into 2 paths
etc, visually exposed inside assembly DLL Entity managed during design fixed data (enums)
Switch onditionals for branching S
C witch/c
ase/b
reak the IDE as reusable Actions, (Server time with strong typing. defined during
Action flow into multiple statement Entities, and Structures. Only) Used for constants and design-time.
paths Extensions are enumerations.
For Each R
epeats Action path Foreachstatement created/modified with
execution Integration Studio.
OutSystems Developer Cheat Sheet v0.8 Page4
You might also like
- Outsystems Associate Reactive Developer Sample Exam0% (2)Outsystems Associate Reactive Developer Sample Exam16 pages
- Study Guide Comprehensive Outline For The OutSystems 11 Web Associate Application Developer Certification Course (Mark A. Ciccarelli)No ratings yetStudy Guide Comprehensive Outline For The OutSystems 11 Web Associate Application Developer Certification Course (Mark A. Ciccarelli)70 pages
- Passing Select-Options To Smart Forms: by VenkatNo ratings yetPassing Select-Options To Smart Forms: by Venkat43 pages
- A Table Control Is An Area On The Screen in Which The System Displays Data in Tabular FormNo ratings yetA Table Control Is An Area On The Screen in Which The System Displays Data in Tabular Form21 pages
- NoteGPT - Video 2 - OData Service - Model, Entity and MPC & DPC ClassNo ratings yetNoteGPT - Video 2 - OData Service - Model, Entity and MPC & DPC Class7 pages
- 3.1. Build A List Screen Exercise - En-UsNo ratings yet3.1. Build A List Screen Exercise - En-Us16 pages
- General + Comments + Formatting: Clean ABAPNo ratings yetGeneral + Comments + Formatting: Clean ABAP4 pages
- Download Data oriented design software engineering for limited resources and short schedules 2nd Edition Richard Fabian ebook All Chapters PDFNo ratings yetDownload Data oriented design software engineering for limited resources and short schedules 2nd Edition Richard Fabian ebook All Chapters PDF55 pages
- General + Comments + Formatting: Clean ABAPNo ratings yetGeneral + Comments + Formatting: Clean ABAP4 pages
- Informatica Etl Naming Conventions:: Repository ObjectsNo ratings yetInformatica Etl Naming Conventions:: Repository Objects11 pages
- Immediate download Data oriented design software engineering for limited resources and short schedules 2nd Edition Richard Fabian ebooks 2024100% (3)Immediate download Data oriented design software engineering for limited resources and short schedules 2nd Edition Richard Fabian ebooks 202455 pages
- Build A Detail Screen Exercise - en-US.11No ratings yetBuild A Detail Screen Exercise - en-US.1129 pages
- Data oriented design software engineering for limited resources and short schedules 2nd Edition Richard Fabian - The complete ebook version is now available for download100% (1)Data oriented design software engineering for limited resources and short schedules 2nd Edition Richard Fabian - The complete ebook version is now available for download62 pages
- Adding Explicit Enhancement To Custom ProgramNo ratings yetAdding Explicit Enhancement To Custom Program78 pages
- Fdocuments - in - Oracle Otl Timecard Layout CustomicationNo ratings yetFdocuments - in - Oracle Otl Timecard Layout Customication43 pages
- General + Comments + Formatting: Clean ABAPNo ratings yetGeneral + Comments + Formatting: Clean ABAP4 pages
- Blender Pro Studio Advanced Techniques for Real-World Projects: Blender, #3From EverandBlender Pro Studio Advanced Techniques for Real-World Projects: Blender, #3No ratings yet
- Getting Started With Quick Test Professional (QTP) And Descriptive ProgrammingFrom EverandGetting Started With Quick Test Professional (QTP) And Descriptive Programming4.5/5 (2)
- Python Advanced Programming: The Guide to Learn Python Programming. Reference with Exercises and Samples About Dynamical Programming, Multithreading, Multiprocessing, Debugging, Testing and MoreFrom EverandPython Advanced Programming: The Guide to Learn Python Programming. Reference with Exercises and Samples About Dynamical Programming, Multithreading, Multiprocessing, Debugging, Testing and MoreNo ratings yet
- Python Important Questions For Mid Term Exam..No ratings yetPython Important Questions For Mid Term Exam..10 pages
- KV Class 3 Half Yearly Previous Year Question Paper 2019 ComputerNo ratings yetKV Class 3 Half Yearly Previous Year Question Paper 2019 Computer2 pages
- DOOR Forms PHIL IRI With Automated Forms and Corrected Errors and Conditions GRADE 5No ratings yetDOOR Forms PHIL IRI With Automated Forms and Corrected Errors and Conditions GRADE 526 pages
- Pakistan International School Jeddah - English Section Academic Session 2021-2022 Book List Y1No ratings yetPakistan International School Jeddah - English Section Academic Session 2021-2022 Book List Y11 page
- 2019-Word of The Lord-Advance Boldly-Ps Ashish RaichurNo ratings yet2019-Word of The Lord-Advance Boldly-Ps Ashish Raichur7 pages
- CS508-Assignment 2 Solution Fall 2024 by M.junaid QaziNo ratings yetCS508-Assignment 2 Solution Fall 2024 by M.junaid Qazi3 pages
- LAS ICT 3 Advanced Word Processing SkillsNo ratings yetLAS ICT 3 Advanced Word Processing Skills15 pages
- Chapter 7 Securing Information Systems.No ratings yetChapter 7 Securing Information Systems.10 pages
- Co-So-Tri-Tue-Nhan-Tao - 2021-Reviewexercise05-Pl-Sol - (Cuuduongthancong - Com)No ratings yetCo-So-Tri-Tue-Nhan-Tao - 2021-Reviewexercise05-Pl-Sol - (Cuuduongthancong - Com)3 pages
- HPE_c04496202_HPE Smart Array P440ar Controller - Product Information ReferenceNo ratings yetHPE_c04496202_HPE Smart Array P440ar Controller - Product Information Reference14 pages
