Introduction to Administration

To learn more about specific Administration use cases, see the How-to Guides: Administration section of our How-to Guides.

Introduction

The Administration Portal lets you manage various aspects of your Unqork account. In this article, you'll learn some of the common ways to use each Administration section. To access the Administration Portal, click Settings on the top navigation bar. Then, click Administration. These are the sections in the Administration Portal:

  • Express Permissions

  • Creator Permissions

  • Assets

  • Modules

  • Environment

  • Integration

What You'll Learn

In this article, you'll take a high-level look at each section's available actions and how you can use them.

Express Permissions

The Administration page lets you manage users and roles separately for Express View and Designer tools. The Express Permissions section of the Administration page is for Express users. These are the users who interact with your application in Express View.

Administration Page

Description

Express Role Administration

The Express Role Administration page lets you create Express roles and set their hierarchy. Unqork classifies users' permissions as roles and groups. Roles determine what users can do. Groups (working together with the role hierarchy) determine what submissions users see. You can use roles to regulate access to a module or component and choose how users interact with data.

Express Group Administration

Express Group Administration lets you add and manage groups for your applications' Express users. Express users are the end-users using your application in Express View. To manage the Express View permissions in your application, separate your Express users into groups and roles. Roles determine what users can do. Groups (working together with the role hierarchy) determine what submissions users see.

Express User Administration

Express User Administration lets you view and manage your Express View end-users. You can also convert Express Administrators to Creator Administrators.

To add a Creator user, go to Creator (User) Administration. You can find the link under the Creator Permissions section.

Creator Permissions

The Creator Permissions section refers to Creator users and roles. This Administration page lets you manage who can edit your application. Creator users can access or edit your application and view their work in Express View. It's important to note that Creator users have access to Express View, but Express users don't have access to Designer tools.

Administration Page

Description

Creator User Administration

Creator (User) Administration lets you add, edit, and delete Creator users. Creator users can build and maintain applications in your Unqork environment. They can also access other Designer tools, including document templates and services. When adding a Creator user, you must assign Creator roles to each person. Creator roles help you set all the behind-the-scenes permissions for your Creator users.

If you only want your end-user to access your Express View application, add them as an Express user. To add an Express user, go to User Administration under the Express Permissions section.

Creator Role Administration

Creator Role Administration lets you add Creator roles and set their permissions. These Creator roles apply to Creator users. These are the users with access to the Designer tools, like the Module Builder. Creator roles let you manage who can edit and organize your applications, themes, services, and so on.

You can add Creator users under Creator (User) Administration and choose which role applies to that user. This lets you customize permissions to best fit your needs.

To manage Express users' roles, go to Role Administration under the Roles and Permissions section.

Assets

Managed Assets Administration lets you store static media files for your application. A static media file is anything from your corporate logo to a supporting image. Once uploaded and linked to your module, these media files show in Express View.

Modules

The Modules section houses Module Administration. For the most part, you work on modules in the Module Builder. The Module Administration page can help you with advanced actions, like promoting a module or restoring an older module version.

Environment

The Environment section of the Administration page handles environment-level settings. You can change the style or theme of your apps or set up performance-tracking tools. You can also change the default landing page for your application or pick a new site name. This section houses Environment Administration, Single Sign-On (SSO), Client Tracker Administration, Style Administration, Email Template Administration, and Global Variables Administration.

Administration Page

Description

Environment Administration

Environment Administration lets you customize behind-the-scenes, environment-related settings (such as adding a Password Reset window).

Single Sign-On (SSO)

The Single Sign-On (SSO) Management page makes it easy to add SSO configurations. From Single Sign-On (SSO) Management, you can easily add, preview, and manage SSO configurations in your environment, using the SSO dashboard.

You can set up SSO configurations for:

  • Express View access: For authentication into the front-end of an application in your environment.

  • Designer access: For authentication in your Unqork environment, known as Designer.

Client Tracker Administration

Client Tracker Administration lets you set up a Client Tracker in your environment. A Client Tracker is used in official integrations with monitoring and performance-tracking tools.

Style Administration

Style Administration lets you change your active styles or promote a style to the next environment. Unqork's Style Team can help style an environment with any desired custom CSS. You create styles in your Staging environment and promote each style theme to higher environments.

Email Template Administration

Email Template Administration lets you customize your environment's default email messages. You can adjust the wording, style, and edit existing templates.

Global Variables Administration

Global Variables Administration provides a uniform way to create and reference global variables across all applications in an environment stage. A global variable is an identifier (or key) paired to a stored value (also known as a key/value pair). Once paired, you can reference the key anywhere in your app. You can also promote global variables across all environments.

Integration

The Integration section lets  you set up integrations, like APIs (application programming interfaces) and SFTPs (secure file transfer protocols). An API is a standardized way of requesting or sending data between systems. The Integration section houses Services Administration, PDF Template Administration, Excel Fill Template Administration, and Start Nodes Administration.

Administration Page

Description

Services Administration

Services Administration lets you set up external APIs and service logs. Service logs log any call you make to an API that you set up in Services Administration. Capturing request and response bodies provides essential information that can help you troubleshoot.

Certificate Management

From Certificate Management, you can easily add, view, and manage mTLS certificates in your environment, using the certificate dashboard. After adding a certificate to your environment, you have a few options for how and where to link services to the certificate:

  • Linking services when adding a certificate to the certificate dashboard.

  • Editing a certificate in the certificate dashboard to link new services.

  • Linking a certificate to a service when adding the service in Services Administration.

  • Editing a service in Services Administration to link a new certificate.

PDF Template Administration

PDF Template Administration lets you manage the PDF templates you generate from submission data.

Excel Fill Template Administration

The Excel Fill Template Administration page lets you upload Excel templates so you can fill them with data from your application. Components transfer the application information from Unqork into your Excel template.

Start Nodes Administration

Start Nodes Administration only applies to workflows. This Administration page lets you start or stop an automated process using Timer Start and Signal Start nodes in your environment.