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
  • General
  • Classes
  • Plugins
  • Time Tracker plugin
  • Search

Was this helpful?

  1. Building an Application
  2. Application Setup

General

All common application properties are grouped under General.

PreviousApplication SetupNextDocumentation

Last updated 3 years ago

Was this helpful?

Navigate to your Workspace > Apps and click on the gear icon to activate the configuration mode of your applications. Next, click on the gear icon of the application you wish to configure. In the App section you click on General to access the App Properties.

General

The General tab contains the properties of the app. These are divided into the sections General, Access and Application Signing. The Info section can only be read.

When you create a new app, the first thing you need to do is enter the key, which must be unique, and the name of the app. Where the name supports multilingualism. A description text field is available to describe the app in more detail.

To be able to publish this application later, author and version must be entered. The version must be specified in the semantics versioning scheme using a three-part version number: major version; minor version; and patch (e.g. 2.1.3).

When the app is subscribed or installed, all changes to the following fields are updated in the derived apps as well:

  • Key (NameID)

  • Name*

  • Description*

  • Info*

  • Color

  • App Icon

  • Version

  • Author

  • IsLicenseRequired

Classes

If you go to the classes tab, all classes of added and created apps of this workspace are displayed. You can select the classes you need for your app. When you select the class, it will be available to the app. The classes you have configured for this app are already selected by default.

Plugins

A plugin on the platform is a widget or a component that can be displayed in the side bar. The plugins respond to user input, which can be different for each plugin.

All available plugins can be activated and set up in the Plugins tab. Since plugins can have different settings, there is a separate section for each plugin type. Currently, only the Time Tracker plugin exists for the platform.

Time Tracker plugin

The Time Tracker plugin is designed to track times. Because the plugin is located in the side bar, the time tracker can be conveniently operated at any time. The plugin serves as a basis for apps that can process and display recorded times. How the app looks or is operated, is up to the app editor.

To activate the Time Tracker plugin, select plugin enabled at the beginning of the section. Next, the class must be selected for the instances of the time tracking. Then a workflow should be selected, which processes the data that the plugin transfers. In the workflow, for example, instances of the previously selected class could be created. The available parameters serve as values (see description in the section). In addition, instances from the parameter list of the workflow can be linked to the Time instance.

Restrictions

When running the time tracker (more precisely, when stopping), instances can be added in the appearing overlay, which are available to the workflow in the form of a list (see image below). Now you would like a certain number of instances of a certain class to be added (linked) to the time tracking instance. Or there must be at least one instance.

This is made possible with the restrictions. A restriction is a class with a minimum and maximum number of instances that can or must be added. The class can be selected from a list of all available classes in this workspace.

Several restrictions can be configured. Of course, existing entries can also be deleted.

After all settings have been made, you can save. If you want to undo the settings you made, you can do it by pressing the button Delete Settings.

Appearance and functionality

After activating the plugin and leaving the edit mode, the time tracker appears in the side bar after a reload of the platform.

The time tracker can be started and stopped at this point. After the start, the timer runs. You can now continue working as usual. Even if you log out, for example, the timer continues to run. When you stop the timer, an overlay pops up. The times are already entered there automatically. Now you can still edit the times and add links of instances. Here the restrictions are taken into account.

Now you have the possibility to delete the timer or to stop the timer. If you want the timer to continue, simply close the window. When the timer is stopped, the workflow configured in the settings is executed. The timer values are transferred to the workflow as parameters. As explained above, the workflow can now prepare the data or directly create and save an instance of a timer class.

Search

The Search tab shows a list of classes that are integrated into the search (side bar search). Here you can exclude or add specific classes.

In the Access section you can control who can use the app. If Application is public is enabled, the app can be installed in other workspaces. Also through the publishing process also cross-platform. For more details see

The Application Signing section is also needed for publishing. Here you can create a signature for the app. More information about this can be found in ..

Publishing the Application
Publishing the Application
Publishing the Application
General tab
Classes
Time Tracker configuration
Restrictions
Time Tracker
Time Tacker overlay
Search tab