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
  • 1. Purpose of the document
  • 2. Source Adapter overview
  • 3. Plugin Service

Was this helpful?

  1. Extensibility and Integration

Source Adapter

A plugin solution from TIVITY.

PreviousREST APINextGetting Started

Last updated 4 years ago

Was this helpful?

1. Purpose of the document

This documentation provides an overview of a plugin solution from TIVITY. First, a brief description of the system is given. After that there is a overview about the process from the plattform request to the adapter and back. Then the individual components are looked at. On the one hand the source adapter itself, on the other hand the REST Service that calls the Adapter.

2. Source Adapter overview

The adapter provides universal access to information sources. These can be database adapters (MS SQL), object adapters (exchange) or document adapters. The result of a request will be given back accordingly universal valid from the respective adapter. Adapter will be used several times for the same kind of information sources (one adapter instance per source). For example, a database adapter can be used for several available databases.

The overview above illustrate adapters beeing applied in the TIVITY plattform itself. These adapters will be configured on the plattform. For example a database adapter could contain the login credentials for the configuration or a WebService adapter contains the URL to the service. There is another possibility to permit the access to information sources per adapter. This possibility will be explained in the next chapter.

3. Plugin Service

There is already an API for the SourceAdapter that can be implement in a REST Service. The service can then communicate with the plattform. This was made possible by a set of interfaces (API) provided by TIVITY. A customer can use this opportunity to develop there own adapter and configurate and call the service from the plattform.

TIVITY provides a own developed REST Service for customers. This service can be used to build your own adapter. There are still exist source code from an example adapter delivered together with the REST Service in one package. Both are Microsoft .NET projects for Visual Studio 2017.

You can also develop your own service which is for example a pure Java Service. And thus you can also have your own adapter in the chosen technology docking on the service. As long as the REST interface corresponds to the provided service interface, the client can communicate within inside the plattform.