Please enable JavaScript.

Coggle requires JavaScript to display documents.

OUTSYSTEMS - Coggle Diagram

- - - - Code Reusability
        
        Screen Actions
        
        Can only be bound to Widgets on a Screen
        
        Do not have Output Parameters
        
        Server Actions
        
        Can be called in any flow
        
        Can have multiple Input + Output Parameters + Local Variables
        
        Can be set as a Function
      - Action Flows
        
        One Start node
        
        End with multiple
        
        Multiple exception handlers
        
        Assign
        
        Set values to variables / parameters)
        
        If
        
        Conditional branch
        
        Switch
        
        Multiple conditional branches
        
        Only one branch of the Switch is executed: the first one that evaluates to True. If none -> Otherwise
        
        For Each
        
        Iterate through a Record List
    - - Exception is thrown when an operation fails
        unexpectedly at runtime
        
        Raising Exceptions
        
        can be
        
        Automatically
        
        Raise Exception
        
        Stop the currently running action flow
        
        Exception: Type of exception
        
        Exception Message
        
        Global Exception Handler
        
        Located in the Common Flow
        
        Should handle all exceptions
        
        Exception Handler Flows
        
        An Action can have several
        
        Security Exceptions
        
        Custom User Exceptions
        
        Database Exceptions
  - - - Validation is performed automatically, when data is submitted to the server
      - Mandatory fields
        
        Data typed in <=> data type of the Variables
    - - Client & Server
        
        Built-in validations are checked on client-side
        
        If valid, submit to the server
        
        If not -> error messages
      - (none)
        
        Inputs are submitted to the server
        
        No built-in validations are performed
      - Server
        
        Inputs are submitted to the server
    - - Valid property = False
      - ValidationMessage
        
        Displays when the input gains focus
  - - - Place breakpoints on elements that generate code
      - Start the debugger before opening the app in the browser
    - - Analyze and correlate logs
      - Service Center: provides log reports: Errors, General, Integrations....
  - - - Screen Actions
        
        Set the Link / Button’s Method to Ajax Submit
        
        Ajax Refresh
        
        Refreshes part of the Screen
        
        Available for named Widgets only
        
        Refreshing Data
        
        Needed before Ajax Refresh
        
        Re-executes an Aggregate or SQL Query
- - - - Input Parameters
        
        Passes a value into its parent’s scope from the outside scope
        
        Is destroyed when execution leaves the scope of the parent element
      - Output Parameters
        
        Returns a value from inside its parent’s scope to the outside scope
        
        A value must be assigned to the Output Parameter inside its scope
        
        Exist in the outside scope even after its parent element’s scope is gone
      - Local Variables
        
        Exists exclusively within the scope of its parent element
        
        Is destroyed when execution leaves the scope of the parent element
  - - - Structures
        
        Store compound data in memory
        
        are not variables, do not hold any value
        
        Structures are defined by attributes of any data type: Structures, Entities and Lists
      - Entities
        
        Entity Actions automatically created
        
        can be used directly in the application logic
        
        CRUD data operations
        
        Create, CreateOrUpdate, Update, Get, GetForUpdate, Delete
        
        Persisted in a Database Table
        
        Row: instance or record
        
        Column: Attribute
        
        Basic data type
        
        Id Attribute
        
        Supports relational database operations
        
        Primary key
      - Static Entities
        
        Get<StaticEntityName> is the only Entity Action
        
        can only contain foreign keys of other Static Entities
        
        Entities have a predefined set of possible values
        
        Attribute
        
        define the structure of the data
        
        automatically created (can be changed)
        
        Is Active
        
        Id
        
        Label
        
        Order
        
        Record
        
        value
    - - Integer, Text, Date, ...
    - - Is a collection of elements of the same data type
      - Elements
        
        Basic types
        
        Compound types
        
        A union record between different types
  - - - Must have -> allow relationships
        
        Id attribute: long integer + auto numbered
        
        Possible types: Text, Integer, Long Integer, Entity Identifier
        
        Mandatory
      - Represents the database table’s Primary Key
        
        No composite keys
    - - Represents Foreign Key
      - NullIdentifier(): default value for reference attributes
      - Entities can be referenced by their identifier
      - Master-Detail Entities
        
        Detail references Master
        
        Detail Entity has a reference attribute (foreign key) of type MasterEntity Identifier (Primary key in Master)
    - - Speed up data retrieval
        
        Reference attributes have automatically created indexes
      - Avoid duplicates: Unique
    - - when deleting a record from the Referenced Entity
        
        Delete: Cascade Delete
        
        Ignore: delete records of the main Entity, keep the associated records in the related Entity.
        
        Protect: no record deleted
    - - represents
        
        Relationships
        
        Delete rule
        
        Entities
- - - - Determines and enforces who( Business Users and Roles) can do what( Business Users and Roles,...)
      - comprises
        
        Authentication
        
        Authorization
    - - Users
        
        Core information
        
        Password
        
        Name
        
        Username
        
        Authorization is granted via Roles
      - Roles
        
        2 built-in Roles
        
        Registered (registered users)
        
        Anonymous (unknown users)
        
        Authorization can be managed
        
        Programatically
        
        Manually in the Users application
        
        Each Role has Check, Grant and Revoke Actions
        
        Can be checked in Screens and Actions
      - Groups
        
        Groups of users
        
        Can be granted a Role
        
        Granted to all Users in group
        
        Can be created and managed
        
        Manually in the Users application
        
        Programmatically with Actions from the Users module
  - - - Store state between requests
      - Session data
        
        Stored in the database
        
        Retrieved by the server in every browser request
        
        Types of cross-request data
        
        Cross-session (Site) Properties
        
        Values are shared between all user sessions
        
        Values never time out
        
        Always available to all users
        
        Data Types
        
        Basic Types
        
        Entity Identifiers
        
        Value is never reset
        
        User Session Variables
        
        Available while a user is using the application
        
        Values are stored per user
        
        Values expire when session times out
        
        Data Types
        
        Basic Types
        
        Entity Identifiers
        
        Value Is reset to its default value when
        
        The session ends (Timeout)
        
        The users log out
      - Created on the first end-user request to the server
        
        It times out after a period of inactivity, session data is discarded
- - - - Web Blank
      - Traditional Web
      - Service
      - Extension
    - - Producers
      - Consumers
        
        Reuses public elements from producers
- - - - Preparation: a special Screen Action
        
        Fetch Data
        
        From Databases: Aggregates & SQL
        
        SQL Tool
        
        SQL Statements are written manually
        
        {Entity}.[Attribute]
        
        Output Entities / Structures: Mandatory to have at least one
        
        Output
        
        Count
        
        List
        
        Aggregates
        
        Aggregating Records
        
        Group multiple rows together: Sum, Average, Min, Max, Count
        
        1 more item...
        
        Calculated Attributes
        
        Custom attributes computed from other attributes in the same query
        
        1 more item...
        
        Properties
        
        Executed SQL property shows the SQL statement generated from the Aggregate
        
        Max. Records: the maximum number of records fetched from the database
        
        Output
        
        Count
        
        List: Current, EOF, BOF, CurrentRowNumber, Length, Empty
        
        Test Values
        
        Test the Aggregate + preview the output records
        
        Specify values for external variables used in the filter / sort conditions
        
        define database queries by:
        
        Add Sources
        
        1 more item...
        
        Define sorting (ORDER BY)
        
        Create filters (WHERE)
        
        1 more item...
        
        From Integrations: Web Services, REST, etc.
    - - Mandatory Input Parameters
        
        2.Empty Non-mandatory Input Parameters + Local Variables
        
        Preparation runs
        
        4.Screen is built from top to bottom
    - - Local Variables
      - Input Variables
    - - visual elements that make up Screens
        
        Properties
        
        should be set properly after dragging the widget to the Screen
        
        Simple Widgets
        
        Text
        
        Image
        
        source is defined in the Type property
        
        External: Accessible through an URL
        
        Database: Binary Data Entity attribute
        
        Static: Image must be included in the module as a resource
        
        Expression: Displays text calculated at runtime
        
        Multiple Record Widgets
        
        Table Records
        
        tabular layout
        
        Bound to a Source Record List
        
        List Records
        
        free-form layout
        
        Bound to a Source Record List
        
        Input Widgets
        
        Label
        
        Can be bound to an Input Widget
        
        Input
        
        Submit data
        
        Bound to a variable
        
        Form Widget
        
        Presents a single record -> display / edit
        
        Bound to a Source Record
        
        Can contain other widgets
        
        Interacting with the app
        
        Links
        
        On Click
        
        Method: how data is submitted to the Server
        
        2 more items...
        
        Destination
        
        2 more items...
        
        Buttons
        
        Container Widget
        
        Groups and applies a style to widgets
        
        If Widget
        
        Boolean condition
        
        Check Box Widget
        
        Bound to a boolean Variable -> True / False value
        
        Radio Button Widget
        
        Select one
        
        Bound to the same variable define a group
        
        Combo Box Widget
        
        drop-down list
        
        from
        
        Source Record List
        
        List of options: Source Record List
        
        Value displayed: Source Identifier Attribute
        
        Special List
        
        List of options: Special List
        
        Value displayed: Options in the Special List
        
        Entity / Static Entity
        
        List of options: Source Entity
        
        Value displayed: Label / Source Attribute
        
        Combining Sources: An Entity / Record List can be combined with the Special List
        
        Placeholder Widget
        
        Only available inside Web Blocks
  - - - Develop once, use many times
      - Improve maintainability: Changes are reflected
    - - Screen Actions
      - Events
      - Preparation
      - Input Parameters
      - Local Variables
    - - Events
        
        can have Input Parameters
        
        can only be triggered in Screen Actions
      - Events Handlers
        
        access to the Event Input Parameters + parent’s scope
        
        Executed when a Web Block raises an Event
- - - - Can provide very detailed contracts
        
        Requests and responses in XML
      - Consuming?
        
        Exposing?
      - SOAP methods
        
        as Server Actions
        
        Possible to change
    - - Lightweight alternative to SOAP
        
        Provide documentation and examples instead of a contract
        
        Requests and responses (usually) in compact JSON
      - Consuming?
        
        Exposing?
      - REST methods
        
        as Actions
        
        Possible to change
      - REST Callbacks
        
        Debug and customize requests
        
        automatically called
        
        OnBeforeRequest
        
        OnAfterResponse