You are reading the documentation for an outdated Corteza release. 2023.9 is the latest stable Corteza release.

Corteza Admin

The administrator panel provides a quick overview of the system; user and role management; permission and settings overview.

To access Corteza Admin, click on a new tab and select it from the list of available applications.

Dashboard

The dashboard section can be accessed by clicking on the "Dashboard" navigation item on the left navigation drawer.

The dashboard provides a quick overview of the system. It shows some simple user, role, and application statistics.

The dashboard will be expanded and improved in the future.

Action log

The action log interface provides an overview of events (actions) that occurred in your system, such as accessing user information, inspecting records, and updating modules.

The action log can be used for debugging, as it provides quite a rich insight into a specific event. You can see the exact error, when it occurred and who caused it.

The action log can be used for administration. For example, you can see who accessed specific information if there was a privacy breach.

Action state

An action can be in one of three states depending on the action:
  • Info: an informative log that something occurred; such as record created, user authenticated, and user information accessed.

  • Warning: a warning log that something failed, but it was not fatal to the operation; such as an invalid login attempt or expired authentication token.

  • Error: an error log that something failed and it should be considered as fatal.

Errors reported by the Corredor server are also visible in the action log.

Listing actions

To list current actions:
  1. navigate to the Corteza Admin,

  2. click on the "Action log" in the navigation drawer,

  3. optionally insert the filtering parameters,

  4. press the "Search" button.

DevNote: Provide more insight into the filtering options.

Inspecting actions

To list current actions:
  1. navigate to the Corteza Admin,

  2. click on the "Action log" in the navigation drawer,

  3. optionally insert the filtering parameters,

  4. press the "Search" button,

  5. click on the action you wish to inspect.

Users

The users interface provides an overview of system users; you can inspect, edit, and delete them.

You can use the users' interface to manually register users that are allowed to access the system.

For privacy reasons, personal information (name and email) is masked by default. You can configure this with permissions for all users or permissions for specific users.

Listing users

To list current system users:
  1. navigate to the Corteza Admin,

  2. click on the "Users" in the navigation drawer,

  3. optionally insert the filtering parameters; the list refreshes automatically.

Creating users

To create a new user:
  1. navigate to the Corteza Admin,

  2. click on the "Users" in the navigation drawer,

  3. click on the "New" button in the top right corner,

  4. provide the requested data (see user parameters),

  5. press the "Submit" button.

You can only define permissions for existing users.

Editing users

To edit an existing user:
  1. navigate to the Corteza Admin,

  2. click on the "Users" in the navigation drawer,

  3. click on the edit icon next to the user you wish to edit,

  4. provide the requested data (see user parameters),

  5. press the "Submit" button.

Suspending users

To suspend an existing user:
  1. navigate to the Corteza Admin,

  2. click on the "Users" in the navigation drawer,

  3. click on the edit icon next to the user you wish to suspend,

  4. click and confirm the "Suspend" button in the "Basic information" section.

Deleting users

You can instead suspend the user.

To delete an existing user:
  1. navigate to the Corteza Admin,

  2. click on the "Users" in the navigation drawer,

  3. click on the edit icon next to the user you wish to delete,

  4. click and confirm the "Delete" button in the "Basic information" section.

Assign role

Each user is automatically a member of the "Everyone" role.

To assign a role to an existing user:
  1. navigate to the Corteza Admin,

  2. click on the "Users" in the navigation drawer,

  3. click on the edit icon next to the user you wish to edit,

  4. select the roles in the "Role membership" section,

  5. press the "Submit" button.

You can only assign roles to existing users.

User parameters

Basic information

The basic user information such as their email, name and a handle (username of a sort).

Password

The password section lets you set the user’s password.

Role membership

Role membership lets you assign roles to a specific user.

The Password and Role membership sections are available only for existing users.

Permissions for all users

Read any user

Determines if the role is allowed to access any user.

Update any user

Determines if the role is allowed to update any user.

Delete any user

Determines if the role is allowed to delete any user.

Suspend any user

Determines if the role is allowed to suspend any user.

Unsuspend any user

Determines if the role is allowed to unsuspend any user.

Show email details

Determines if the role is allowed to see the email address of any user.

Show name details

Determines if the role is allowed to see the name of any user.

Impersonate any user

Determines if the role is allowed to impersonate any users.

Permissions for a specific user

Read ("user name")

Determines if the role is allowed to access the given user,

Update ("user name")

Determines if the role is allowed to update the given user,

Delete ("user name")

Determines if the role is allowed to delete the given user,

Suspend ("user name")

Determines if the role is allowed to suspend the given user,

Unsuspend ("user name")

Determines if the role is allowed to unsuspend the given user,

Show email details for ("user name")

Determines if the role is allowed to see the email address of the given user,

Show name details for ("user name")

Determines if the role is allowed to see the name of the given user.

Impersonate this user ("user name")

Determines if the role is allowed to impersonate the given user.

Roles

The roles interface provides an overview of system roles; you can inspect, edit, and delete them.

A role defines a user group that specifies a set of permissions for the system resources.

Listing roles

To list current system roles:
  1. navigate to the Corteza Admin,

  2. click on the "Roles" in the navigation drawer,

  3. optionally insert the filtering parameters; the list refreshes automatically.

Creating roles

To create a new role:
  1. navigate to the Corteza Admin,

  2. click on the "Roles" in the navigation drawer,

  3. click on the "New" button in the top right corner,

  4. provide the requested data (see role parameters),

  5. press the "Submit" button.

You can only define permissions for existing roles.

Editing roles

To edit an existing role:
  1. navigate to the Corteza Admin,

  2. click on the "Roles" in the navigation drawer,

  3. click on the edit icon next to the role you wish to edit,

  4. provide the requested data (see role parameters),

  5. press the "Submit" button.

Archiving roles

To archive an existing role:
  1. navigate to the Corteza Admin,

  2. click on the "Roles" in the navigation drawer,

  3. click on the edit icon next to the role you wish to archive,

  4. click and confirm the "Archive" button in the "Basic information" section.

Deleting roles

You can instead archive the role.

To delete an existing role:
  1. navigate to the Corteza Admin,

  2. click on the "Roles" in the navigation drawer,

  3. click on the edit icon next to the role you wish to delete,

  4. click and confirm the "Delete" button in the "Basic information" section.

Assign members

To assign users to a role:
  1. navigate to the Corteza Admin,

  2. click on the "Roles" in the navigation drawer,

  3. click on the edit icon next to the role you wish to assign to,

  4. select the users in the "Role members" section,

  5. press the "Submit" button.

You can only assign members to existing roles.

Role parameters

Basic information

The basic role information such as the name and the handle (system identifier).

Role membership

Role members lets you add members to a specific role.

The Role members section is available only for existing roles.

Permissions for all roles

Read any role

Determines if the role is allowed to see any role.

Update any role

Determines if the role is allowed to update any role.

Delete any role

Determines if the role is allowed to delete any role.

Manage members for any role

Determines if the role is allowed to add/remove members from any role.

Permissions for a specific role

Read (role name)

Determines if the role is allowed to see the given role.

Update (role name)

Determines if the role is allowed to update the given role.

Delete (role name)

Determines if the role is allowed to delete the given role.

Manage members for (role name)

Determines if the role is allowed to add/remove members from the given role.

Applications

The applications interface provides an overview of your applications; you can inspect, edit, and delete them.

The applications are listed in the Corteza One.

Listing applications

To list current applications:
  1. navigate to the Corteza Admin,

  2. click on the "Applications" in the navigation drawer,

  3. optionally insert the filtering parameters; the list refreshes automatically.

Creating applications

To create a new applications:
  1. navigate to the Corteza Admin,

  2. click on the "Applications" in the navigation drawer,

  3. click on the "New" button in the top right corner,

  4. provide the requested data (see application parameters),

  5. press the "Submit" button.

You can only define permissions for existing applications.

Editing applications

To edit existing applications:
  1. navigate to the Corteza Admin,

  2. click on the "Applications" in the navigation drawer,

  3. click on the edit icon next to the application you wish to edit,

  4. provide the requested data (see application parameters),

  5. press the "Submit" button.

Deleting applications

To delete an existing application:
  1. navigate to the Corteza Admin,

  2. click on the "Applications" in the navigation drawer,

  3. click on the edit icon next to the application you wish to delete,

  4. click and confirm the "Delete" button in the "Basic information" section.

Application parameters

Basic information

The basic application information such as the name and its status.

Unify app selector

Specifies how the application is displayed such as the icon and what Low Code namespace to use.

Permissions for all applications

Access any application

Determines if the role is allowed to access any application.

Update any application

Determines if the role is allowed to update any application.

Delete any application

Determines if the role is allowed to delete any application.

Permissions for a specific application

Access (application name)

Determines if the role is allowed to access the given application,

Update (application name)

Determines if the role is allowed to update the given application,

Delete (application name)

Determines if the role is allowed to delete the given application.

Settings

The settings interface allows you to configure some core system settings.

There is a separate view for system, Corteza Messaging, Corteza Low Code, and Corteza One.

System settings

Authentication

The authentication section lets you control the authentication flow, email notifications, and where to redirect successful logins.

Email

The email section lets you define the system email templates.

This email template does not affect emails sent from the Low Code.

External authentication

The external authentication section lets you configure what authentication providers are available (if at all). See Configuring external authentication providers for configuration details.

You can disable internal sign-up and manually add users that are allowed to access your system.

Low Code

Basic

Basic system configuration such as UI tweaks and attachment constraints (size and type).

Messaging

Basic

Basic system configuration such as UI tweaks and attachment constraints (size and type).

One

Logo

The logo section lets you replace the default Corteza logo with your own.

Panels

The panels section lets you define the default layout for your users.

Permissions

The permissions interface allows you to configure core system-level permissions.

There is a separate view for system, Corteza Messaging, and Corteza Low Code.

These rules apply to automation scripts. If a user is not allowed to access Low Code, the triggered automation script is also not allowed to access Low Code.

Corteza system

System service permissions

Allow access to administration

Determines if the role is allowed to access the administration panel (the web application being defined here),

Grant permission on system service

Determines if the role is allowed to grant permissions on system service,

Access all settings

Determines if the role is allowed to access any setting defined under the system,

Manage all settings

Determines if the role is allowed to manage and edit any setting defined under the system,

Create new organization

Determines if the role is allowed to create a new organization.

Create new role

Determines if the role is allowed to create a new role.

Create new user

Determines if the role is allowed to create a new user.

Create new application

Determines if the role is allowed to create a new application.

Allow reminder assignment

Determines if the role is allowed to assign reminders to other users.

Organizations

Access to all organizations

Determines if the role is allowed to access any organization.

Applications

Access any application

Determines if the role is allowed to access any application.

Update any application

Determines if the role is allowed to update any application.

Delete any application

Determines if the role is allowed to delete any application.

Users

Read any user

Determines if the role is allowed to access any user.

Update any user

Determines if the role is allowed to update any user.

Delete any user

Determines if the role is allowed to delete any user.

Suspend any user

Determines if the role is allowed to suspend any user.

Unsuspend any user

Determines if the role is allowed to unsuspend any user.

Show email details

Determines if the role is allowed to see the email address of any user.

Show name details

Determines if the role is allowed to see the name of any user.

Impersonate any user

Determines if the role is allowed to impersonate any users.

Roles

Read any role

Determines if the role is allowed to see any role.

Update any role

Determines if the role is allowed to update any role.

Delete any role

Determines if the role is allowed to delete any role.

Manage members for any role

Determines if the role is allowed to add/remove members from any role.

Corteza Low Code

Service permissions

If a role doesn’t have access to the Corteza Low Code, they will also not be able to access any application defined as a Corteza Low Code namespace.

Access to compose

Determines if the role is allowed to access Corteza Low Code.

Create namespaces

Determines if the role is allowed to create namespaces for Corteza Low Code.

Grant permissions on compose service

Determines if the role is allowed to manage permissions for Corteza Low Code.

Access all settings

Determines if the role is allowed to read any setting for Corteza Low Code.

Manage all settings

Determines if the role is allowed to manage any setting for Corteza Low Code.

Namespaces permissions

Access any namespace

Determines if the role is allowed to access any Corteza Low Code namespace.

Update any namespace

Determines if the role is allowed to update any Corteza Low Code namespace.

Delete any namespace

Determines if the role is allowed to delete any Corteza Low Code namespace.

Manage any namespace

Determines if the role is allowed to manage any Corteza Low Code namespace.

Create modules under any namespace

Determines if the role is allowed to create modules for any Corteza Low Code namespace.

Create charts under any namespace

Determines if the role is allowed to create charts for any Corteza Low Code namespace.

Create pages under any namespace

Determines if the role is allowed to create pages for any Corteza Low Code namespace.

Modules permissions

Read any module

Determines if the role is allowed to access any Corteza Low Code module.

Update any module

Determines if the role is allowed to update any Corteza Low Code module.

Delete any module

Determines if the role is allowed to delete any Corteza Low Code module.

Create record under any module

Determines if the role is allowed to create records for any Corteza Low Code module.

Read records under any module

Determines if the role is allowed to access records for any Corteza Low Code module.

Update records under any module

Determines if the role is allowed to update records for any Corteza Low Code module.

Delete records under any module

Determines if the role is allowed to delete records for any Corteza Low Code module.

Module fields permissions

Read any module field

Determines if the role is allowed to see any Corteza Low Code module field.

Update any module field

Determines if the role is allowed to update any Corteza Low Code module field.

Charts permissions

Read any chart

Determines if the role is allowed to see any Corteza Low Code chart.

Update any chart

Determines if the role is allowed to update any Corteza Low Code chart.

Delete any chart

Determines if the role is allowed to delete any Corteza Low Code chart.

Pages permissions

Read any page

Determines if the role is allowed to see any Corteza Low Code page.

Update any page

Determines if the role is allowed to update any Corteza Low Code page.

Delete any page

Determines if the role is allowed to delete any Corteza Low Code page.

Corteza Messaging

Service permissions

Access to messaging

Determines if the role is allowed to access Corteza Messaging.

Grant permissions on messaging service

Determines if the role is allowed to grant permissions on Corteza Messaging.

Access all settings

Determines if the role is allowed to access any Corteza Messaging setting.

Manage all settings

Determines if the role is allowed to manage any Corteza Messaging setting.

Create public channels

Determines if the role is allowed to create public Corteza Messaging channels.

Create private channels

Determines if the role is allowed to create private Corteza Messaging channels.

Create direct messages and group channels

Determines if the role is allowed to create direct Corteza Messaging channels to a specific user or a set of.

Channels permissions

Update any channel

Determines if the role is allowed to update any Corteza Messaging channel.

View any channel

Determines if the role is allowed to access any Corteza Messaging channel.

Join any channel

Determines if the role is allowed to join any Corteza Messaging channel.

Leave any channel

Determines if the role is allowed to leave any Corteza Messaging channel.

Delete any channel

Determines if the role is allowed to delete any Corteza Messaging channel.

Undelete any channel

Determines if the role is allowed to undelete (restore) any Corteza Messaging channel.

Archive any channel

Determines if the role is allowed to archive any Corteza Messaging channel.

Unarchive any channel

Determines if the role is allowed to unarchive any Corteza Messaging channel.

Manage members on any channel

Determines if the role is allowed to add or remove any Corteza Messaging channel members.

Manage attachments on any channel

Determines if the role is allowed to manage attachments of any Corteza Messaging channel.

Message sending on any channel

Determines if the role is allowed to send massages to any Corteza Messaging channel.

Reply to messages on any channel

Determines if the role is allowed to reply (create threads) to any Corteza Messaging channel message.

Embedding in messages on any channel

Determines if the role is allowed to embed external resources to any Corteza Messaging channel message.

File attaching on any channel

Determines if the role is allowed to upload files (attachments) to any Corteza Messaging channel.

Update own messages on any channel

Determines if the role is allowed to update own messages of any Corteza Messaging channel.

Update any message on any channel

Determines if the role is allowed to update any message or any Corteza Messaging channel.

Delete own messages on any channel

Determines if the role is allowed to delete own messages of any Corteza Messaging channel.

Delete any message on any channel

Determines if the role is allowed to delete any message of any Corteza Messaging channel.

React on messages on any channel

Determines if the role is allowed to add reactions to any message of any Corteza Messaging channel.

Automation

The automation interface provides an overview of processed automation scripts.

The automation interface can be used to debug issues regarding invalid or missing automation scripts.

Refer to deploying extensions for details on how to deploy extensions.

Listing automation scripts

To list current automation scripts:
  1. navigate to the Corteza Admin,

  2. click on the "Automation" in the navigation drawer,

  3. optionally insert the filtering parameters; the list refreshes automatically.

Invalid automation scripts show an error message.

Inspecting automation scripts

To inspect specific automation scripts:
  1. navigate to the Corteza Admin,

  2. click on the "Automation" in the navigation drawer,

  3. click on the blue button next to the label.

You can inspect the automation script properties, such as the trigger and security context.

Invalid automation scripts show an error message.

Configuring external authentication providers

Google

To enable Google authentication, you need to retrieve your application credentials:
  1. Go to Google Sign-in Guide and click on "Configure a project" button.

  2. Select an existing or create a new project.

  3. Set a product name.

  4. On "Configure your OAuth client" screen select "Web browser" and paste the URL where your Corteza system is running (including https://).

  5. Copy and paste both Client ID and Client Secret fields to Corteza Admin.

Facebook

To enable Facebook authentication, you need to retrieve your application credentials:
  1. Go to Facebook for developers website, click on "Add a new app" or select an existing app.

  2. In the list of available products search for "Facebook Login" and click on the "Set Up" button.

  3. Select "Web" platform and paste the URL where your Corteza system is running.

  4. Go to "Settings" and then "Basic" in the left sidebar.

  5. Copy and paste both App ID and App Secret fields to Corteza Admin; app ID maps to client key, app secret maps to secret.

GitHub

To enable GitHub authentication, you need to retrieve your application credentials:
  1. Go to GitHub and create a new OAuth application.

  2. Copy and paste both Client ID and Client Secret fields to Corteza Admin.

LinkedIn

To enable LinkedIn authentication, you need to retrieve your application credentials:
  1. Go to LinkedIn, fill out the form and click on "Create app".

  2. Go to Auth section and copy and paste both the Client ID and Client Secret fields to Corteza Admin.