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
  • Overview
  • Settings
  • Parameter
  • Executing

Was this helpful?

  1. Building an Application
  2. Execution

Functions

This section covers how functions can be created and customized on the platform to cater for operations in an application.

PreviousExecutionNextWorkflows

Last updated 4 years ago

Was this helpful?

Overview

Functions are used on the platform to define dynamic actions in your application. They are scripts with input parameters which in turn can be called in scripts. The Function Designer provides an interface for creating and managing functions.

On the start page of the Designer, all available functions are listed. In addition, new functions can be created. In the context menu of an instance these actions can be performed:

  • Clone: an exact copy of this instance is created and added to the list

  • Used By: Listed all class, function, layout, selection, workflow, template who use this instance

  • Delete: delete this instance

Settings

The Key property is compulsory when creating a function.

Parameter

It is possible to add parameters to a function. These are queried in the interface when the function is executed.

The Key is the parameter name with which you can access it in the script context. The Type property defines the layout control with which the parameter query will be displayed later during execution. If Required is enabled, an input is forced. The Actions offered deleting and moving (changing the order) of a parameter.

The Key property is compulsory when creating a parameter.

Executing

After the function is created and a script is built, this function is available to the app. In each script in the different contexts, this function can now be called. These includes Workflow Designer, Template Designer and of course in another function. To execute the function in the script, the action ExecuteFunction is offered. When this action is added in the designer, you can choose from a list of available functions.

The interface of the function settings are divided into three sections. In General the function name and description of the function are entered. In addition, a unique key must be assigned. With this key the function can be called at another place. In the Function section, the underlying script can be created or opened. How scripts are built you can . The return type of the function is also set at this point. Finally, under Parameter the input parameters can be configured. How to add and configure parameters is described in the next chapter.

see in Scripting
Function Designer
Function settings
Parameter configuration
ExecuteFunction action