# Docs ## Docs - [TIVITY Documentation](https://docs.tivity.one/tivity-documentation.md): Your Guide to Low-Code App Development - [Getting Started](https://docs.tivity.one/overview/getting-started.md): Learn the core concepts of the Tivity Platform by building a To Do Application - [Creating A New Application](https://docs.tivity.one/overview/getting-started/creating-an-application.md): Steps to create a new application on the TIVITY Platform - [Adding Basic Structure using Class Designer](https://docs.tivity.one/overview/getting-started/adding-basic-structure-using-class-designer.md): Creating new classes and adding fields to it using the Class Designer. - [Creating a link to the TIVITY File Class](https://docs.tivity.one/overview/getting-started/creating-a-link-to-the-tivity-file-class.md): Creating a link to the TIVITY File Class to add the ability to upload files to our tasks. - [Setting Rights](https://docs.tivity.one/overview/getting-started/setting-rights.md): Setting up rights and permissions for the Editor and Viewer groups of our application. - [Creating Queries](https://docs.tivity.one/overview/getting-started/creating-queries.md): Creating queries to retrieve to dos from our database using the Query Desinger - [Building The Layout](https://docs.tivity.one/overview/getting-started/building-the-layout-1-2.md): Using the Query Designer to create the user interface of our application. - [Creating an App Page](https://docs.tivity.one/overview/getting-started/building-the-layout-1-2/the-app-page.md): Creating a Start Page in the Layout Designer using the App Page - [Creating an Object Page](https://docs.tivity.one/overview/getting-started/building-the-layout-1-2/the-object-page.md): Creating an object page to that we will use for a detailed view and edit tasks. - [Creating a List Item Layout](https://docs.tivity.one/overview/getting-started/building-the-layout-1-2/creating-a-list-item-layout.md): Creating a List Item Layout to customise the results list of the queries. - [User-Interface](https://docs.tivity.one/overview/user-interface.md) - [Shortcuts](https://docs.tivity.one/overview/shortcuts.md): This section lists all the keyboard shortcuts supported by the platform. - [Architecture](https://docs.tivity.one/overview/architecture.md) - [Application Setup](https://docs.tivity.one/building-an-application/application-setup.md) - [General](https://docs.tivity.one/building-an-application/application-setup/general.md): All common application properties are grouped under General. - [Documentation Management Tool](https://docs.tivity.one/building-an-application/application-setup/documentation.md): This section describes how to create documentation for an application and provide it to an app user. - [License Management](https://docs.tivity.one/building-an-application/application-setup/license-management.md): Creating and activating licenses. - [Publishing the Application](https://docs.tivity.one/building-an-application/application-setup/publishing-the-application.md): Self-built apps can be published on other platforms or workspaces (e.g. public). Versioning is available to manage the publishing process. - [Advanced Settings](https://docs.tivity.one/building-an-application/application-setup/advanced-settings.md): Within the Advanced Settings designer, you can adjust the behavior of the platform while doing specific tasks - [Document-MailEditor](https://docs.tivity.one/building-an-application/application-setup/advanced-settings/document-maileditor.md): This configuration allows you to adjust the behavior of the mail editor for each document class. - [Data](https://docs.tivity.one/building-an-application/data.md) - [Sources](https://docs.tivity.one/building-an-application/data/sources.md) - [Data Modelling](https://docs.tivity.one/building-an-application/data/data-modelling.md): Data Modelling on the platform makes use of the Class Designer allowing a user to manage classes, fields, actions and links. It is closely related to the database as well. - [Class](https://docs.tivity.one/building-an-application/data/data-modelling/class.md): The class editor within the class designer allows the user to customize their classes and database structures. This section dives into how to properly set up your class in your application. - [Field](https://docs.tivity.one/building-an-application/data/data-modelling/field.md): The field editor within the class designer allows the user to customize their field. This section introduces the process to create a field, and provides in-depth information about its properties. - [Action](https://docs.tivity.one/building-an-application/data/data-modelling/action.md): The action editor within the class designer allows the user to customize their actions. This section introduces the process to create an action, and provides in-depth information about its properties. - [Link](https://docs.tivity.one/building-an-application/data/data-modelling/link.md): Links within an application represent the relationship between its classes. This section introduces the process of creating a new link, and provides a detailed breakdown of its customization options. - [Query Designer](https://docs.tivity.one/building-an-application/data/query-data.md): Query Designer in TIVITY is similar to a visual data retrieval tool you might use with a relational database model or NoSQL instance. - [Get Started with Query Designer](https://docs.tivity.one/building-an-application/data/query-data/get-started-with-query-designer.md): The article gives a brief tutorial about how to create a query using the Query Designer. - [Common](https://docs.tivity.one/building-an-application/data/query-data/query-designer-common.md): Query Designer is divided into several sections - Common, Fields, Conditions, Default Values and Preview. This article provides detailed information about the Common section. - [Fields](https://docs.tivity.one/building-an-application/data/query-data/query-designer-fields.md): Query Designer is divided into several sections - Common, Fields, Conditions, Default Values and Preview. This article provides detailed information about the Fields section. - [Conditions](https://docs.tivity.one/building-an-application/data/query-data/query-designer-conditions.md): Query Designer is divided into several sections - Common, Fields, Conditions, Default Values and Preview. This article provides detailed information about the Conditions section. - [Default Values](https://docs.tivity.one/building-an-application/data/query-data/query-designer-default-values.md): Query Designer is divided into several sections - Common, Fields, Conditions, Default Values and Preview. This article provides detailed information about the Default Values section. - [Preview](https://docs.tivity.one/building-an-application/data/query-data/query-designer-preview.md): Query Designer is divided into several sections - Common, Fields, Conditions, Default Values and Preview. This article provides detailed information about the Preview section. - [Views](https://docs.tivity.one/building-an-application/views.md) - [Layout Designer](https://docs.tivity.one/building-an-application/views/design-ui.md): Interface design on the platform is done via the Layout Designer - a tool specifically created to help build clean graphical layouts for your users to interact with your application. - [Page Types](https://docs.tivity.one/building-an-application/views/design-ui/page-types.md): The Layout Designer provides support for different page types that are designed to cater for different needs that your application may have. This section explores each page type individually. - [Fields and Links](https://docs.tivity.one/building-an-application/views/design-ui/fields-and-links.md): Layouts are closely related to class definitions. This section explores how application classes and its properties can be integrated into a layout for further interaction from the end user. - [Layout Controls](https://docs.tivity.one/building-an-application/views/design-ui/layout-controls.md): Layouts created in the Layout Designer require visual elements to provide the best application experience. This section covers the different components available on the platform for this purpose. - [Actions](https://docs.tivity.one/building-an-application/views/design-ui/layout-controls/actions.md): This section covers action controls that consist of components allowing the user to trigger commands when interacting with the application. - [Panels](https://docs.tivity.one/building-an-application/views/design-ui/layout-controls/panels.md): This section covers panel controls that allows layouts to be graphically designed in various and flexible ways to provide for a great user experience when using an application. - [Sections](https://docs.tivity.one/building-an-application/views/design-ui/layout-controls/sections.md): This section covers section controls provided by the platform as graphical components that enhances the esthetics of an application layout or page. - [Lists](https://docs.tivity.one/building-an-application/views/design-ui/layout-controls/lists.md): This section covers list controls that are particularly useful when a large amount of information needs to be presented to the user in an easily consumable format. - [Input](https://docs.tivity.one/building-an-application/views/design-ui/layout-controls/input.md): This section covers input controls that allows the user to enter data in order to provide parameter values for further interaction with an application. - [Layout Templates](https://docs.tivity.one/building-an-application/views/design-ui/layout-templates.md): This section covers a series of templates provided by the platform to allow a quick and easy configuration of layouts commonly used in applications. - [Document Templates](https://docs.tivity.one/building-an-application/views/document-templates.md): The TIVITY platform enables you to generate documents and emails using templates the easy way. - [Get started with Template Designer](https://docs.tivity.one/building-an-application/views/document-templates/get-started-with-template-designer.md): The article gives a brief tutorial about how to create a document template using the Template Designer. - [Expressions in Templates](https://docs.tivity.one/building-an-application/views/document-templates/expressions-in-template.md): Complete reference of built-in expressions in Templates of the TIVITY platform. - [Execution](https://docs.tivity.one/building-an-application/execution.md) - [Functions](https://docs.tivity.one/building-an-application/execution/functions.md): This section covers how functions can be created and customized on the platform to cater for operations in an application. - [Workflows](https://docs.tivity.one/building-an-application/execution/workflows-and-application-logic.md): This section covers how workflows can be created and customized on the platform to cater for complex operations in an application - [Control Types](https://docs.tivity.one/building-an-application/execution/workflows-and-application-logic/control-types.md): The control type specifies the type of editor with which a user can insert values for the parameter. - [Trigger](https://docs.tivity.one/building-an-application/execution/trigger.md): This section covers how trigger can be created and customized on the platform to trigger for operations in an application. - [Scripting](https://docs.tivity.one/building-an-application/execution/scripting.md): The Script Designer of the TIVITY platform adds custom functionality to your app. Scripts are used to process your data in workflows. - [Accessing the Script Designer](https://docs.tivity.one/building-an-application/execution/scripting/accessing-the-script-designer.md): The Script Designer is a central feature in the TIVITY platform and the Scripting functionality is available in various areas. - [Using the Script Designer](https://docs.tivity.one/building-an-application/execution/scripting/using-the-script-designer.md): Tailor-made functionalities for your app are quite common. In this article we cover the use of the Script Designer to create such features. - [Commonly used Actions](https://docs.tivity.one/building-an-application/execution/scripting/commonly-used-actions.md): Actions are the backbone of the scripting capability in the TIVITY platform. This article lists and described a few commonly used Actions and provides examples of use. - [Reference: Actions](https://docs.tivity.one/building-an-application/execution/scripting/functions.md): Complete reference of built-in actions in the TIVITY platform. - [Math](https://docs.tivity.one/building-an-application/execution/scripting/functions/math-actions.md) - [System](https://docs.tivity.one/building-an-application/execution/scripting/functions/system-actions.md) - [Date](https://docs.tivity.one/building-an-application/execution/scripting/functions/date-actions.md) - [Collection](https://docs.tivity.one/building-an-application/execution/scripting/functions/collection-actions.md) - [LogicalOperators](https://docs.tivity.one/building-an-application/execution/scripting/functions/logicaloperators.md) - [Web](https://docs.tivity.one/building-an-application/execution/scripting/functions/web.md) - [Structure](https://docs.tivity.one/building-an-application/execution/scripting/functions/structure.md) - [Constants](https://docs.tivity.one/building-an-application/execution/scripting/functions/constants.md) - [Converters](https://docs.tivity.one/building-an-application/execution/scripting/functions/converters.md) - [Commands](https://docs.tivity.one/building-an-application/execution/scripting/functions/commands.md) - [Text](https://docs.tivity.one/building-an-application/execution/scripting/functions/text.md) - [PDF](https://docs.tivity.one/building-an-application/execution/scripting/functions/pdf.md) - [Operators](https://docs.tivity.one/building-an-application/execution/scripting/functions/operators.md) - [PowerPoint](https://docs.tivity.one/building-an-application/execution/scripting/functions/powerpoint.md) - [QR-/Barcode](https://docs.tivity.one/building-an-application/execution/scripting/functions/qr-barcode.md) - [Messaging](https://docs.tivity.one/building-an-application/execution/scripting/functions/messaging.md) - [Cells](https://docs.tivity.one/building-an-application/execution/scripting/functions/cells.md): Script actions to create and manipulate Excel documents (workbooks). - [Xml](https://docs.tivity.one/building-an-application/execution/scripting/functions/xml.md) - [Admin](https://docs.tivity.one/building-an-application/execution/scripting/functions/admin.md): The following actions on this page are only available in the Admin Center (SAML scripts). - [Integrations](https://docs.tivity.one/building-an-application/execution/scripting/functions/integrations.md) - [Expressions](https://docs.tivity.one/building-an-application/expressions.md) - [Expressions in Expressions](https://docs.tivity.one/building-an-application/expressions/expressions-in-expressions.md): Complete reference of built-in expressions in the Expressions of the TIVITY platform. - [Expressions in Condition Values](https://docs.tivity.one/building-an-application/expressions/expressions-in-condition-values.md): Complete reference of built-in expressions in the Conditions of the TIVITY platform. - [Templates](https://docs.tivity.one/platform-features/templates.md): This page covers advanced TIVITY template features: image handling, language settings, and custom functions for dynamic and powerful document generation. - [Tagging](https://docs.tivity.one/platform-features/tagging.md): Overview, usage and configuration of Tagging feature - [Getting Started](https://docs.tivity.one/platform-features/tagging/getting-started.md): Overview of the Tagging feature - [Manage Tags](https://docs.tivity.one/platform-features/tagging/manage-tags.md): Learn how to create and group tags - [Settings](https://docs.tivity.one/platform-features/tagging/settings.md): Set up Tagging feature for the most efficient usage - [Usage](https://docs.tivity.one/platform-features/tagging/usage.md): Tag filter for the lists/boards and instance interface - [Tag filter](https://docs.tivity.one/platform-features/tagging/usage/tag-filter.md) - [Tag panel](https://docs.tivity.one/platform-features/tagging/usage/tag-panel.md): How to use the tag panel - [Document Management System (DMS)](https://docs.tivity.one/platform-features/document-management-system-dms.md) - [DMS Setup](https://docs.tivity.one/platform-features/document-management-system-dms/dms-setup.md): Tivity DMS Setup command-line interface provides a tool to install or uninstall the TIVITY DMS which handles document related actions. - [Enterprise Search](https://docs.tivity.one/platform-features/enterprise-search.md) - [Enterprise Search Introduction](https://docs.tivity.one/platform-features/enterprise-search/enterprise-search-introduction.md): TIVITY's Enterprise Search is a powerful, centralized search solution that enables users to find information across multiple applications and data sources within their organization. - [Integration into an App](https://docs.tivity.one/platform-features/enterprise-search/integration-into-an-app.md): There are numerous options for app creators to integrate search with the data of an App. - [General Settings](https://docs.tivity.one/platform-features/enterprise-search/general-settings.md) - [Roles & Permissions (Team app)](https://docs.tivity.one/managing-users-and-collaboration/roles-and-permissions.md): This part of the documentation goes though the ways to assign usage and access rights to users on the TIVITY platform. - [Rights Designer](https://docs.tivity.one/managing-users-and-collaboration/roles-and-permissions/rights-designer.md): This section will go through using the Rights Designer to specify the access rights of roles of users in an application - [Access Control Lists (ACL)](https://docs.tivity.one/managing-users-and-collaboration/access-control-lists-acl.md): This part of the documentation will go through how to set up ACL as an application creator and how to enforce ACLs as a workspace administrator. - [Platform (Admin Center)](https://docs.tivity.one/administration/platform.md): Basic configuration of the platform. - [Workspace](https://docs.tivity.one/administration/workspace.md): General configuration of workspaces on the platform - [Security](https://docs.tivity.one/administration/security.md) - [Platform Setup](https://docs.tivity.one/administration/platform-setup.md): TIVITY Core Setup CLI guide: installation, update, and uninstallation processes. Covers setup options, cached settings, and command verbs for efficient platform management and configuration. - [Breaking changes](https://docs.tivity.one/administration/breaking-changes.md): Breaking changes and migration guides. - [REST API](https://docs.tivity.one/extensibility-and-integration/rest-api.md) - [Source Adapter](https://docs.tivity.one/extensibility-and-integration/source-adapter.md): A plugin solution from TIVITY. - [Getting Started](https://docs.tivity.one/extensibility-and-integration/source-adapter/getting-started.md) - [Source Adapter Interface](https://docs.tivity.one/extensibility-and-integration/source-adapter/source-adapter-interface.md) - [RESTful Adapter Service](https://docs.tivity.one/extensibility-and-integration/source-adapter/rest-service.md): Documentation about an example of a RESTful api service that consumes a source adapter. - [Exchange Adapter](https://docs.tivity.one/extensibility-and-integration/source-adapter/exchange-adapter.md) - [IMAP Adapter](https://docs.tivity.one/extensibility-and-integration/source-adapter/imap-adapter.md) - [Adapter Portfolio](https://docs.tivity.one/extensibility-and-integration/adapter-portfolio.md) - [MongoDB Adapter](https://docs.tivity.one/extensibility-and-integration/adapter-portfolio/mongodb-adapter.md): This adapter represents a MongoDB adapter for authentication and CRUD operations. It can be used the query and manipulate collections and nested arrays inside of collections. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.tivity.one/tivity-documentation.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.