Spaces

Tenants within the Kinetic Platform

Overview

Spaces are the framework used to provide multi-tenancy to the Kinetic Platform. Spaces separate users, configurations, and data into distinct tenants.

Navigating to a Space

Spaces are subdomains of the application's host location. For instance, those using our hosted platform kinops would have a Space address of https://‹my-space-slug›.kinops.io. For customer-managed environments, the platform might be hosted at https://kinetic.example-company.com, and so the Space's URL would be https://‹my-space-slug›.kinetic.example-company.com.

Space-Wide Settings

Settings are either managed at the Space level or at the Kapp level. The following configurations are managed at the Space level:

  • Space settings
  • Teams
  • Users
  • Space, team, and user attributes
  • Bridges with bridge models and mappings
  • Space security definitions
  • Creation of Kapps
  • Space, team, and user webhooks
  • Routines

Note: Space-wide settings can be used for all Kapps within a Space.

Details

Space Settings: Details tab

Space Settings: Details tab

The Details tab provides basic details about the Space and information specific to the Display Type the Space uses.

The tab contains the following information:

  • Space Name: This is the displayed name of the space.

  • Space Slug: This is the unique identifier of the space. You will see it in the URL when accessing the space.

  • Inactive Session Limit: Number of seconds the session can be inactive before it ends.

  • Bundle Path: The server path to the bundle (if not using a shared bundle).

  • Display Type: The Display Type controls the method the Platform will use to display the Space. The remaining options on this tab are determined by which Display Type is enabled. There are three options available:

  • Display Page: Uses a JSP to display the space and allows you to configure what JSP should be rendered.

    • Space Display Page: The page in the bundle used to display the space.

    • After Logout Page: The page to redirect to after a user logs out.

    • Login Page: The page that opens when a user logs in.

    • Reset Password Page: Page in the bundle used for password reset requests.

      Display Type set to Display Page

      Display Type set to Display Page

  • Redirect: Redirects a user when they try to display the space and allows you to enter a Redirect URL.

    Display Type set to Redirect

    Display Type set to Redirect

  • Single Page App: Configures the system to use a client-side bundle and configure its location. This setting disables display settings at the Kapp level and assumes all routing will happen on the client side.

Display Type set to Single Page App

Display Type set to Single Page App

Attributes

Space Settings: Attributes tab

Space Settings: Attributes tab

The Attributes tab assigns values to the space-level attributes configured in the Space Definitions.

Typically, attributes defined here are used in workflows and/or the bundle. These attributes are used across all Kapps. Some examples include:

  • Task Server URL
  • Web Server URL
  • Admin Kapp Slug
  • Header Bundle Path

Along with the Space-level attributes, you can set fallback attributes for Kapps and forms used if attributes are not defined at those levels. These include:

  • Approval Form Slug
  • Submission Workflow
  • Form Workflow

OAuth

Space Settings: OAuth tab

Space Settings: OAuth tab

The OAuth tab is used to configure Single Sign On information for other systems that act as clients of the Space.

Example of an OAuth configuration

Example of an OAuth configuration

Security

Space Settings: Security tab

Space Settings: Security tab

The Security tab lets you assign access permissions for the Space itself and access, create, and modify teams and users. These options include:

  • Space Display
  • Team Membership Modification
  • User Access
  • User Creation
  • User Modification
  • Team Access
  • User Creation
  • User Modification

The Trusted Resource Domains and Trusted Frame Domains lists are displayed underneath the settings. Here, you can set up other servers or URLs as trusted domains. This can help you investigate any cross-origin resource-sharing issues you encounter.

Important! Adding domains to these lists can introduce security risks. Use caution when changing these options.

Workflow

The Workflow tab is used to configure workflows at the Space level. It's divided into four tabs.

Engine

Workflows tab: Engine settings

Workflows tab: Engine settings

The Engine tab lists the status of the workflow engine and provides options to stop or start it. You can also define the source name for the Kinetic Platform.

Categories

Workflows tab: Category settings

Workflows tab: Category settings

Categories allow you to label and group Handlers and Routines for easy reference within the Platform. You can create, edit, and delete categories from this tab.

Click on a category name to see the details for that category. These details include:

  • Name: The category name.
  • Description: A description of the category.
  • Handlers: A list of handlers associated with the category. You can add a new handler by selecting one from the drop-down list.
  • Routines: A list of routines associated with the category. You can add a new routine by selecting one from the drop-down list.
  • Policy Rules: Indicates which users have access to the category and its contents. These options are set on the Policy Rules tab.
Workflows tab: Category example

Workflows tab: Category example

Policy Rules

The Policy Rules tab is where you set new policy rules for controlling user access to categories, consoles, and APIs. Users not meeting the assigned criteria cannot access the associated components.

Workflows tab: Policy Rule settings

Workflows tab: Policy Rule settings

Click on a policy rule name to see the details for that category. These details include:

  • Type: Indicates whether the policy rule applies to categories, workflow console areas, or defined API sources.
  • Name: The policy rule name.
  • Rule: The logic and conditions used to test if the rule will apply.
  • Message: The message to display when a user does not meet the policy rule requirements.

Each policy rule also has a section specific to the type of rule being configured where you can indicate which console (for consoles), which category (for categories), or which source (for APIs) the policy rule should apply to.

Workflows tab: Policy rule example

Workflows tab: Policy rule example

System Errors

Workflows tab: System Errors view

Workflows tab: System Errors view

The System Errors section lists workflow errors for review and potential resolution. Using the Show Filters option, you can filter the list to show only Active or Handled errors. To view more details about an error, click the error number in the Error ID column.

The error details page displays the error type, the date of occurrence, and the reason behind the error. You can mark errors as resolved by entering a resolution description in the Notes box and clicking Resolve.

Workflows tab: System error example

Workflows tab: System error example