Skip to main content

Admin CMS

This is the other component getting generated besides the Swagger Docs, the admin panel (or CMS) is a modern UI interface for you (the app owner) to visually interact and manage data in your app.

Usage

1. Set Password For Admin

The moment you navigate to My App for the first time after you generate a new app, you will be asked to enter a password for the created-by-default admin account, afterwards, you will use this password to login to your admin account inside the admin panel/CMS.

popup2

After setting the admin password, you will get automatically logged in to the Admin CMS and the API Playground.

2. Admin Home Page

Now you are logged in and redirected to the Admin Home Page, this is where you can fully interact with the admin panel and the data/tables/entities in your generated application.

Note that the permissions of the logged in user apply, so you can only do what you are permitted to do, this includes viewing, creating, updating, and/or deleting.

admin_home

As you can see, the entities that were created during the generation phase would appear to the left and you can click on any one of them to manage this specific entity, below is an example for the Todo entity:

admin_entity

3. Entity Create

By default there would be no instances of that entity created, click on the + Create button (shown above) to start creating instances of that entity:

entity_create

Fill the inputs with some valid data and click on the Save button to finish creating the entity:

element_created

Note that some fields might be Optional in the database table for that entity, so as expected it wouldn't require you to enter it in the admin panel UI.

4. Create Lists on Entities

You can also create lists (columns with multiple values) of different types with ease, you will have a plus icon to add more to the list representing the column's value.

ap_list

The values you add are validated and the admin panel will give you correct input type for each type (String, Numeric, etc...).

added_vals

This is how the list columns (Num Tags and Str Tags) are presented in the admin panel:

ap_show_list

Permissions

By default, if you are the one who generated the application, you will be an admin user (a user with having the admin role), so you have the permissions to perform any actions when it comes to the admin panel, other users can access the admin panel, but the actions that they are able to perform is limited to the permissions that they have.

Permissions include:

  • create
  • read
  • update
  • delete

Non-admin users

If you navigate to any entity as a non-admin user you will no longer see the + Create button, because you don't have the create permission, but as a non-admin user you have read permissions by default and will be able to use the admin panel in a read-only way.

cms_perm

Requesting permissions

To get the permission to do something create, read, update, or delete, you have to ask an admin user to give you the permission to do so using the specific role of your account, which is named after your username.

The admin should navigate to the RolePermission entity, which is used to connect permissions to a specific Role, then create a new entry.

give_perm

gave_perm

then the non-admin user will have the permission to perform that action, in the above example, the user will be able to create tasks, and it is the same exact procedure to give any other permissions to users.

Operations on Tables

1. Searching

The admin panel provides an easy way to perform text search on your table:

ap_search

The table showing the results will show only the results that satisfy the search criteria:

search_res

2. Selecting Columns

You can use the Select feature to show certain columns in your table and omit other columns.

cols

If the switch is on it means that this column is included in the response, otherwise it is ommitted.

This is a result for selecting the Title and Description.

select_res

3. Export Data As CSV

You can also export your data as CSV.

Just click on the Export button.

export

It will automatically download a CSV file containing your data.

Files

For entities with at least one media type field, you will be able to upload/view/delete/update files related to that entity.

Usage

Navigate to an entity having one or more media fields, when creating a new row for that entity, you will find an upload area where you can either browse files or drag and drop:

admin_media_create

Choose one or more files to upload (depending on whether you chose to support multiple values for that field or not):

admin_media_choose

Click on Save to save upload your files, then you can navigate to the added row and preview your files:

media_preview

To edit/delete files, click on Edit:

edit_images

Remove images or re-upload others as you wish, then click Save to apply:

images_delete

Note that we don't have good support for videos and audio yet, but those are coming soon, and the max file size to upload is 5MB.