Learn how to use CYPEX the easy way
Watch our tutorial videos in the CYPEX Online Academy
Check out our video library here:
Table of contents
- CYPEX installation and initial login
- CYPEX overview and first application in a few minutes
- CYPEX application “database” section
- CYPEX application “authentication” section
- CYPEX application “file management” section
- CYPEX application “audit” section
- CYPEX application “data API” section
- CYPEX application “add-ons” section
- CYPEX application “application designer” section
- 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.
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.
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
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.
- Database section (model builder)
- Generate default query
- Generate query
- Database section default lookup
- Database section auditing
- Database section table details
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”.
- Authentication section overview
- Managing internal user accounts
- Manage roles
- Login settings
- Login using LDAP server
- Repository configuration
- Explore the repository content and install applications
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.
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.
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.
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.
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 huge variety of field types (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 are working with autocomplete and syntax highlighting.
Furthermore, CYPEX offers special design and grouping functions. A container element allows you to group elements wihin 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 easily generate content on the fly. Not to forget about images! They are one of the most basic design elements on any page. They are not only used statically but 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 lets you 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 timesaving functions, find out about:
- Application overview
- Data display element
- Array text input
- Autocomplete input element
- Boolean input element
- Code input
- Application layout elements
- “Form” & “Display” – List elements
- Color field
- Date time input
- JSON input
- Markdown input element
- Number input element
- Slide input
- Subform table
- Text input element
- File input
- Multiple file input
- Action buttons in action
- Array text field
- Boolean field
- Call button in action
- Circular progress
- “Copy to clipboard” buttons
- Color field
- Date time field
- External link field
- Internal link button
- Internal link field
- JSON field
- Modal dialog
- Number field
- Text fields
- Text input
- 3rd Party
- Adding an autocomplete field to an application
- Show current user data
- Sending email with pg_timetable (sample app)
- Creating related table views (sample app)
- Refreshing after saving a form (sample app)
See examples in the CYPEX Online Academy design best practice showcases section.
SUBSCRIBE TO OUR NEWSLETTER