Docs
  • Getting Started
  • Overview
    • Understanding
      • User-Interface
      • Shortcuts
    • Getting Started
      • Creating A New Application
      • Adding Basic Structure using Class Designer
      • Creating a link to the TIVITY File Class
      • Setting Rights
      • Creating Queries
      • Building The Layout
        • Creating an App Page
        • Creating an Object Page
        • Creating a List Item Layout
  • Building an Application
    • Application Setup
      • General
      • Documentation
      • License Management
      • Publishing the Application
      • Advanced Settings
        • Document-MailEditor
    • Data
      • Sources
      • Data Modelling
        • Class
        • Field
        • Action
        • Link
      • Query Data
        • Get Started with Query Designer
        • Common
        • Fields
        • Conditions
        • Default Values
        • Preview
      • Roles & Permissions
        • Rights Designer
      • Access Control Lists (ACL)
    • Views
      • Design UI
        • Page Types
        • Fields and Links
        • Layout Controls
          • Actions
          • Panels
          • Sections
          • Lists
          • Input
        • Layout Templates
      • Document Templates
        • Get started with Template Designer
        • Expressions in Templates
    • Execution
      • Functions
      • Workflows
        • Control Types
      • Trigger
      • Scripting
        • Accessing the Script Designer
        • Using the Script Designer
        • Commonly used Actions
        • Reference: Actions
          • Math
          • System
          • Date
          • Collection
          • LogicalOperators
          • Web
          • Structure
          • Constants
          • Converters
          • Commands
          • Text
          • PDF
          • Operators
          • PowerPoint
          • QR-/Barcode
          • Messaging
          • Cells
          • Xml
          • Admin
          • Integrations
    • Expressions
      • Expressions in Expressions
      • Expressions in Condition Values
  • Administration
    • Platform
    • Workspace
    • Security
    • Platform Setup
  • Extensibility and Integration
    • REST API
    • Source Adapter
      • Getting Started
      • Source Adapter Interface
      • RESTful Adapter Service
  • Adapter Portfolio
    • MongoDB Adapter
  • Platform Features
    • Enterprise Search
      • Integration into an App
      • General Settings
    • Templates
    • Tagging
      • Getting Started
      • Manage Tags
      • Settings
      • Usage
        • Tag filter
        • Tag panel
    • DMS Setup
Powered by GitBook
On this page
  • Workspaces
  • Platform Users
  • Platform Config
  • Schedule Maintenance
  • Platform Features
  • Platform Branding
  • System Apps
  • Password Settings
  • Script Settings
  • SMTP Settings
  • Mail Settings
  • Notification Settings
  • Tagging Settings
  • Asynchronous Preview Generation
  • Grid Column Reordering
  • Limitations
  • Selection Filter
  • Workspace Templates
  • Other Settings
  • Help Settings
  • Misc
  • Platform Actions
  • Platform Configurations
  • Feedback

Was this helpful?

  1. Administration

Platform

Basic configuration of the platform.

PreviousExpressions in Condition ValuesNextWorkspace

Last updated 9 months ago

Was this helpful?

The configuration of the platform is done in the Admin Center. Only the administrator of the platform has access to the Admin Center. In this area workspaces and new users can be created or general settings of the platform can be made. In addition, various settings such as app management or platform tasks are also located here.

To enter the Admin Center it is necessary to log in as administrator. Under the Account Settings menu you can select the Admin Center. This selection is not available for normal users and App Creator.

After opening the Admin Center the different setting areas are shown in the tabs.

Overview of the configuration tabs

Workspaces

For the documentation of the workspace configuration there is a separate chapter under the topic Administration.

Platform Users

Under the tab 'Platform Users' you get a list of all users of this platform. Here the administrator can delete or configure users. There will also be the unconfirmed users, i.e. those who register after a registration and receive an email but not response.

To view the details of a user click on an entry from the list. A new map with the details opens. In the header area there are more options in the menu. Here the administrator can delete a user. The two actions "delete user" and "delete user persistent" are available.

With "Delete user" this user remains in the database. He is only marked as "deleted". If the action "delete persistently" has been executed, the user is deleted irrevocably and cannot be restored.

Platform Config

Here the platform can be individually adapted. In addition, further functionalities can be activated. We will go through all the points from top to bottom.

Schedule Maintenance

Under "Schedule Maintenance" information of maintenance work can be displayed. The text of the information can be entered individually. An Html editor is available for formatting the text e.g. links. The message text can be entered in several languages (currently only German/English).

Afterwards the start date can be entered when the maintenance work starts. Next the end date is selected. This is the period of time when the user of this platform can see the information about the maintenance.

As soon as the maintenance appointment starts, the information is displayed on the platform's surface. Directly on the login page as well as on the main page at the top, a colored highlighted field with the information appears.

Platform Features

The "Platform Config" panel provides various settings for hiding and showing buttons. In addition, further cross-platform settings can be made here.

These settings allow administrators to streamline workspace creation and maintain consistency across the platform:

  • Config Mode: display Config Mode button (#1). The button is always enabled for the platform administrator.

  • Default workspace templates: Workspaces which are used as templates when creating default workspaces (MultiSelect). See “Workspace templates”.

  • New workspace template: Workspace which is used as a template when creating a new workspace (ComboBox). See “Workspace templates”.

Global Add Button: display Add button

  • App Menu Button: display App Menu button

  • Add App Button: display Add App button (#2)

  • User Registration Button: display the User Registration button

  • Add Team Button: display Add Team button

  • Delete Team Button: display Delete Team button

  • Invitations: display Invitations button (#3 and #4)

  • Delete User From Team: display Delete User From Team button

  • Dropbox Button: display Dropbox button

  • Personal Workspace: display Personal Workspace (#5)

  • Config Mode: display Config Mode button (#1)

  • Feedback Button: Feedback button is only displayed if the option is checked. Also sending feedback is not possible if the option is unchecked. (#6)

  • Staying Signed In: enable how long the users staying in without new login

  • User Can Change Abbreviation: Users can change their abbreviation in the account settings

Platform Branding

Setup the branding of the platform by setting the app name, app icon, sidebar app name and sidebar app logo.

Pressing Reset on the bottom of the Platform Branding resets app name, app icon, sidebar app name and sideber app logo to platform default settings value.

System Apps

Configure whether system-wide apps are displayed or not. The following apps can currently be configured:

  • Activity App

  • Activity Ticker

  • Dashboard App

  • License App

  • Reporting App

Password Settings

Here you can configure the strength of the password. And the error output if the validation fails.

For the password strength a regular expression pattern is used. The error message can be entered in German and English.

Script Settings

Script Settings section has the option Action Platform Administrator Restriction which is by default enabled. It restricts script actions, so that they cannot be used outside of platform administrative scripts.

There are two levels for script actions:

  1. User - Script actions can be used in every script. No restriction exists.

  2. Platform Administrator - Script actions can only be used in platform-wide scripts (SAML scripts). Saving scripts with these script actions or execution of these scripts outside of the restriction results in an error.

SMTP Settings

Here you can configure the SMTP (simple mail transfer protocol) server that is used for sending mails from the Platform Admin. Required are the host, port and credentials. SSL, Anonymous and Domain are optional.

Mail Settings

With this settings you can first enter an email address that is used for sending mails from the platform.Then follows a set of settings for various standard mails that the platform sends. The text of a mail subject and the body can be adjusted there.

  • From Address: An email address that is used for sending emails from the platform.

  • BCC Addresses: Email addresses which are added as BCC when system emails are sent. The addresses are added in the following cases: activation, registration or invitation of a new user, changing the user’s email address and resetting the user’s password. If there are multiple email addresses, they are separated by a semicolon.

  • Then follows a set of settings for various standard emails that the platform sends. The text of a mail subject and the body can be adjusted here.

Notification Settings

This settings offers to customize the shell text for notifications in English and German language. They are divided into 3 types of notifications.

Email notifications

This notification is sent when there are unread messages in the platform notifications and the throttle time has expired. The throttle time can be configured in the user's account settings.

These parts of a notification can be configured:

  • Subject (only for multiple notifications)

  • Body

  • Separator (separates multiple notifications)

The following placeholder can be used in subject and body:

  • {FIRST_NAME}: The first name of the recipient

  • {LAST_NAME}: The last name of the recipient

  • {NOTIFICATIONS_BODY}: The notification body (or all bodies separated)

  • {NOTIFICATIONS_COUNT}: The count of new notifications

  • {NOTIFICATIONS_LINK}: The link to all notifications

Unread chat messages

This notification is sent when there are unread chat messages and the throttle time is expired. e throttle time can be configured in the user's account settings.

These parts of a notification can be configured:

  • Subject

  • Body

  • Separator (separates multiple notifications)

The following placeholder can be used in subject and body:

  • {FIRST_NAME}: The first name of the recipient

  • {LAST_NAME}: The last name of the recipient

  • {MESSAGES_BODY}: The chat message to notify of (or all messages separated)

  • {MESSAGES_COUNT}: The count of unread messages

  • {MESSAGE_LINK}: The link to the chat

Share messages

This notification is sent when a share action is performed on an instance.

These parts of a notification can be configured:

  • Subject

  • Body

The following placeholder can be used in subject and body:

  • {SENDER_FIRST_NAME}: The first name of the sharing user

  • {SENDER_LAST_NAME}: The last name of the sharing user

  • {TEXT}: The text added by the sharing user

  • {CONTEXT_NAME}: The name of the shared instance

  • {CONTEXT_LINK}: The link to the shared instance

Tagging Settings

Platform administrator regulates in Tagging settings the Tagging feature and its usability through workspaces:

Prerequisite for the activation of the Tagging feature and its usage accross the platform is that platform administrator sets the Tagging feature to Enabled.

If the platform admin sets the Tagging Settings to not enabled, then the Tagging feature is also not visible for the Workspace administrator in the Teams App Settings:

If the platform Administrator sets the Tagging Setting to enabled, but disables the Workspace enableable option, the Tagging feature is visible for the Workspace administrator, but cannot be disabled:

Last but not least, if the platform administrator enables the option Workspace enabled default, then the Tagging feature will be enabled by default when installing the new workspace:

Asynchronous Preview Generation

The Platform automatically generates a PDF from non-image documents to be able to preview them within the browser. This preview generation happens asynchronously after the user uploads a non-image document in the background. While the preview generation is happening, the user will see a loading indicator when he opens a Page which displays that documents preview. The user can continue to work while the loading is happening.

To ensure that the system itself is not overloaded, the number of parallel preview generations is tight to the number of CPU cores available on the server. The formula for the number if 33% => x Number of CPU cores.

Grid Column Reordering

The order of Columns within a Grid can be changed. To change the order of a column, click and hold on the header of the column to change and move it while keeping the mouse button clicked. When reaching the place where the column should move to, release the mouse button.

The order of the columns will be preserved for a single Page. If a page gets closed and opened again at a later point in time, the column order will be the previously customized order.

Limitations

The column order can not be changed when the content of the grid is grouped by a one or more columns

The column order is not preserved for hierarchical grids.

Changing the column order will collapse all open sub levels within a grid.

The column order will not be preserved in the Reporting App.

Selection Filter

With the selection filter, the content of a Grid can be reduced to only show rows which have specified values.

Adding a filter

To open the selection filter for a given column, click on the left Column Actions button within the header. In the appearing Drop Down Menu, select Selection filter.

A popup will appear which will list all unique values from all items of the current column. Mark the values which should be kept by clicking on them.

After clicking on Update, only rows which have the selected values will get displayed. Additionally, a filter bar will appear above the Grid to give a quick glance which columns have which filtered values.

Modifying or removing a filter

To modify an currently active filter, click on the corresponding item in the filter bar or use the same drop down menu which was used to create a filter. A popup will appear where the filter can be modified.

To remove a filter, click on the X in the filter bar or unselect all values when the filter modification popup is visible.

Adding more filters

The filter bar shows an additional button which allows to add more filters quickly if at least one filter is already active. Clicking on that button will display a list of columns filters can be added to as well.

Remark: The list will also contain columns which already have a filter. If such a column is selected, the modification popup for that filter will get shown.

Remark: Multiple filters are applied using the AND operator. Meaning that all filters must match for each row to be become visible.

Negating a filter

If the option Exclude selected values within the filter popup is enabled, the Grid will only show rows which do not match the selected values for this column. Additionally, the filter bar will show a red indicator for that filter.

Select All

When using the Column Filter, all currently visible items can be selected at once. To do that, click on the All checkbox within the header of the list of possible values.

Remarks: If the list contains more than 1000 unique items, it will be limited to the first 1000 items. Selecting all will also only select the first 1000 items. Additionally, a warning will indicate that the list is truncated.

Limitations

The selection filter is not available if the Grid displays grouped content.

Workspace Templates

A workspace template is a workspace defining the apps and the app data that are pre-installed in new workspaces. Any workspace can be used as a template. Workspace templates are used for two purposes.

Default workspace template:

This option specifies which workspaces will be used as templates for default workspaces when a new user is registered or created in the Admin Center. If no templates are selected, the new users will have no default workspaces. If one or more templates are selected, the corresponding number of workspaces will be created with the same names as the names of the templates. If a template workspace has apps installed, those apps will be installed in the corresponding default workspace of a new user. If some data is defined in a template app, this data will be copied to the corresponding app in the default workspace. This allows for example creating a default workspace with several apps defined, so that every new user will have the same set of apps installed. Another example is a demo workspace template, so that every new user will get a workspace with demo apps and demo data.

New workspace template:

This option specifies a workspace which will be used as a template for any new workspace created by a user or by the platform administrator in the Admin Center. The apps and the app data defined in this template will be added to the new workspace, so that every new workspace will have the same set of apps installed. When the platform is installed, two workspaces are created: “Default workspace” and “New workspace”. The owner of these workspaces is the admin user. The first one is set as the Default workspace template, the second one is set as the New workspace template.

Other Settings

Currently there is only one setting in Others Settings. Here you can enter the Google API key.

Help Settings

For external help pages settings can be made here. These help links are called on the main page of the platform. There you will find a '? button. Clicking on it opens a dropdown menu which contains the two entries for external pages / links.

Misc

In Misc they can perform actions or administrative tasks on the platform. In addition, administrative configurations can be made here.

Platform Actions

  • Restart application: the restart of the web application is forced

  • Clear repository cache: the cache of the platform is cleared so it can be rebuild

  • Repair document index: the document index is read in again

Platform Configurations

App Management is used to manage the apps that are available on the platform. The apps can be imported here and then installed as well.

Feedback

All platform users can share the user experience topics like suggestions, feature improvements, bugs, compliments or any other comments with the Feedback feature.

The feedback subject is not a mandatory field and can contain up to 100 characters, while feedback message can contain up to 2000 characters and is a mandatory field.

Due to browser restrictions, certain parts of the screenshot may be missing. Please make sure that everything important is visible or make you own screenshot.

Security

The documentation of the security settings can be found in the chapter Security.

.

.

For more details see the chapter .

Feedback form is opened by clicking on the Feedback in the top right corner.

In addition, up to 3 screenshots can be either uploaded (PNG or JPEG, maximum size 2 MB) or automatically generated by pressing Generate . For the latter the screenshot of the actual browser content is taken.

Workspaces: Configuration of all workspaces of the platform.
Workspace
Publishing the Application
Security
Platform Users: Here all users can be viewed and edited
Platform Config: Different configurations concerning the platform
Misc: Miscellaneous
User configuration menu
Admin Center card
User configuration
User details
Platform Config Options
Html editor for entering text
Example of a configured schedule
Login page
Admin Center - Platform Config
Setup of Platform Branding
System Apps
Default Script Settings Status
Mail Settings
Tagging Settings
Tagging settings set to enabled
Tagging Settings disabled
Team Settings has no Tagging Feature
Tagging enabled, but Workspace enableable disabled
Tagging feature cannot be disabled
Tagging settings enabled by default
Grid Column Reordering
Selecting a filter
Priority values
Task management interface
List of filters
Negating a Filter
Categories List
Warning - Maximum units selected
overview Misc tab
User Feedback
Feedback Form