Learn how to use CYPEX the easy way

Watch our tutorial videos in the CYPEX Online Academy

CYPEX Online Academy video tutorials

Start with an overview of the dashboard. Once you understand the basics, graduate to the more nuanced aspects. For example, you’ll learn how to use location data, or how to insert JavaScript notation for the most flexible and beautiful charts. Not only will you come away with fresh knowledge of how to quickly build applications, you’ll see how easy it is to use CYPEX for truly astonishing results. It’s a low-code approach that you can instantly update.

CYPEX - PostgreSQL application building
Easy-to-use dashboards; attractive, yet practical graphical user interface

Check out our video library here:

Table of contents

  1. CYPEX installation and initial login
  2. CYPEX overview and first application in a few minutes
  3. CYPEX application “database” section
  4. CYPEX application “authentication” section
  5. CYPEX application “file management” section
  6. CYPEX application “audit” section
  7. CYPEX application “data API” section
  8. CYPEX application “add-ons” section
  9. CYPEX application “application designer” section
  10. CYPEX application “design best practice” section

1. Installation and first login

In this chapter, you’ll be introduced to the very first steps within CYPEX.

We provide you with a Git repository which allows you to download, install and configure it. All containers are provided for direct use. As CYPEX can be connected with existing databases, you’ll need to provide information to tell it where PostgreSQL can be found (such as: host, port, and database name).

You’ll also get to know the admin panel.

The admin panel is a core component of CYPEX – it allows you to gain an overview of which applications exist and to define new applications by adding workflows.

  1. Setup and Login for the first time
  2. Setup and Login using an external database
  3. Administration Overview

 

Learn how to install CYPEX

2. CYPEX overview and first application in a few minutes

CYPEX applications are not built from scratch– they’re predicted first.

The predicted application is then modified by the user to satisfy their needs. The application section within the admin panel helps users generate new apps. A user can select a handful of queries (or all of them) and provide some meta data. The CYPEX engine will use this information to make predictions. In this chapter, you’ll learn how to create your first CYPEX application in just over 10 minutes. You’ll start with a data model and end up with a full-fledged application.

  1. Application section
  2. Create an application in a few minutes

 

Watch the tutorials about how to create your first application

3. CYPEX application database section

The model builder

Once you’ve become familiar with the admin panel, move on to the CYPEX model builder . The CYPEX model builder allows you to inspect the current data model as it is in PostgreSQL and define basic CYPEX objects such as queries, workflows, etc.
Furthermore, default queries are a core concept of the entire CYPEX system. Learn how to mark which tables you need with the help of a default query. The default query is assigned permissions. Depending on the extent of the user’s permissions, the query will be available as a data source in the GUI or will be unavailable to that user.

The query builder

Another tool we provide helps construct queries. Plain tables are often not a good data source. You’ll need joins, aggregations, windowing functions, etc. To make sure that such operations are permitted, make use of our
query builder.

Build workflows

CYPEX offers a simple way to create workflows, an important cornerstone of the modern application-building process. Building workflows is easy in CYPEX; they allow you to move quickly from a data model to a complete application. Workflows can be changed in CYPEX without having to re-generate the application all over again. Simply go to the model builder and adjust the workflow as needed. All changes will be directly reflected in the GUI.

States & triggers; default lookups

In CYPEX, the state machine allows you to transition from one state to another. Connecting all states by hand can be cumbersome. CYPEX features the ability to “fully connect” states with each other. The idea is to have a workflow that allows for state changes from every state to every other state, ridding you of the extra work.
In order to automate various operations, triggers in PostgreSQL are offered to improve your data model.

Default lookups help to fix relational data models that would usually show ID’s as opposed to names.

Audit your application

One of the core features of CYPEX is adding auditing to your application. Enable the “audit” feature for a relation in order to track it. The CYPEX admin panel allows you to inspect your tables as well as the relations between them.

If you click on a relation, you’ll also be able to see table details.

 

  1. Database section (model builder)
  2. Generate default query
  3. Generate query
  4. Workflows
    1. Workflow overview
    2. Change workflow and see the update in the app
    3. Creating a new workflow
    4. Change an existing workflow
    5.  Trigger function integration
  5. Database section default lookup
  6. Database section auditing
  7. Database section table details

 

Learn more about workflows

4. CYPEX application authentication section

Authentication & security

The CYPEX model builder allows you to configure the authentication strategy of your application and helps you to configure your security model.

New users; login screen

Creating new users in CYPEX is easy. Simply go to the “Users” section in the admin panel. Add and remove users in the “Users” section within the admin panel. There you can decide who is allowed to make use of your applications. Create and add roles as you need it in the admin panel.

The application authentication section allows you to customize your login screen. You can set the logo as well as the title.

CYPEX supports SSO authentication

In a large corporation, Single-Sign-On is the authentication method of choice. CYPEX supports SSO authentication and allows you to connect user management to LDAP.

By including ready-made extensions we’ve drastically reduced the overhead of high-usage services (e.g. addresses and country lists). CYPEX has all the means to do more with less time.

2 repository types

And last but not least, there are 2 types of repositories: extensions and ready-made apps. The structure of these two types of repositories are slightly different. Depending on the type of repo, it will either show up in “repository applications” or in “extensions”.

 

  1. Authentication section overview
  2. Managing internal user accounts
  3. Manage roles
  4. Login settings
  5. Login using LDAP server
  6. Repository configuration
  7. Explore the repository content and install applications

 

Read more about authentication in CYPEX

5. CYPEX application file management section

File storage that can handle user-uploaded files is a must for every web editor. You can quickly integrate photos into all upcoming apps, while keeping the flexibility to backup data and programs all at once by utilizing the CYPEX file store.

 

Find out more about file management options 

6. CYPEX application audit section

Critical applications need auditing. CYPEX has onboard means to handle this, out-of-the-box. Click on relations in the ER editor and enable the audit module. CYPEX will configure all that is needed for you.

 

Learn more about auditing

7. CYPEX application data API section

CYPEX automatically exposes your data as an easy-to-use API which allows you to integrate your database with external platforms in a straightforward manner. The APIs automatically keep up to date in case changes are made to the data model.

 

Watch the tutorial about “Data API”

8. CYPEX application add-ons section

CYPEX allows you to hook up to a repository and load ready-made SQL fragments directly into your application, allowing you both to perform basic common tasks more quickly and to achieve a higher level of quality at those tasks.

Repository applications are applications which can be directly downloaded into your CYPEX deployment. These video tutorials show how such applications can be made.

 

  1. Add-Ons
  2. Create a repository application 

 

Learn more about add-ons

9. CYPEX application designer section

In this chapter, you’ll learn how to create a sample application based on an existing database model.

Watch our videos and have a look at the large variety of field types available (e.g. boolean with “true” & “false”, code input fields, date & time inputs, number fields, slide input, text elements, multiple file input fields, array text fields, buttons, subform tables,   …). Many of these field types support autocomplete and syntax highlighting.

Furthermore, CYPEX offers special design and grouping functions. A container element allows you to group elements within a grid. They can be conditional as well. Markdown fields are a generic way to add content to the screen. They can be linked to other elements on the page and are therefore an easy way to display things and to generate content on the fly. Don’t forget about images! There one of the most basic design elements on any page, and are often subject to dynamic behavior. CYPEX lets you work with color fields. CYPEX is able to display a square containing a color to indicate information on the page.

On top of that, CYPEX allows you to edit JSON documents using a special GUI element. The key advantage is that the GUI element assures that the JSON document sent to the backend is always valid, which helps to avoid errors.

CYPEX offers many more time-saving functions, find out about:

  1. Application overview
  2. Data display element
  3. Array text input
  4. Autocomplete input element
  5. Boolean input element
  6. Code input
  7. Application layout elements
    1. Container
    2. Conditional container
    3. Markdown text element
    4. Image element
  8. “Form” & “Display” – List elements
    1. Color field including examples
    2. Date time input
    3. JSON input
    4. Markdown input element
    5. Number input element
    6. Slide input
    7. Subform table
    8. Text input element
    9. File input
    10. Multiple file input
    11. Action buttons in action
    12. Array text field
    13. Boolean field
    14. Call button in action
    15. Circular progress
    16. “Copy to clipboard” buttons
    17. Color field element basics
    18. Date time field
    19. External link field
    20. Form
    21. Internal link button
    22. Internal link field
    23. JSON field
    24. Modal dialog
    25. Number field
    26. Table
    27. Tabs
    28. Text fields
    29. Text input
  9. Charts
    1. Bar chart element
    2. Custom chart element
    3. Line chart element
    4. Pie chart element
  10. 3rd Party
    1.  Leaflet map GeoJSON field
    2. Geographic inputs (managing GIS data)

 

Get to know the application designer in detail

10. CYPEX application design best practice section : Coding Examples (Javascript code examples)

  1. Adding an autocomplete field to an application
  2. Show current user data
  3. Sending email with pg_timetable (sample app)
  4. Creating related table views (sample app)
  5. Refreshing after saving a form (sample app)

 

See examples in the CYPEX Online Academy design best practice showcases section.

Have a look at our showcases

YouTube

By loading the video, you agree to YouTube's privacy policy.
Learn more

Load video

SUBSCRIBE TO OUR NEWSLETTER