Table of Contents

Framework modules

The framework offers several modules that can be integrated into your clusters for extended functionality. Currently, here are the available modules:

  • NeosAICore: Adds AI functionalities.
  • NeosCore: Adds core functionalities.
  • NeosDashboard: Adds dashboard.
  • NeosDataExchange: Adds configurable server data export and CSV data import features.
  • NeosNotificationCenter: Adds a notification center with history to your cluster.
  • Onboarding: Integrates an onboarding tool into your cluster.
  • TaskSchedulerClient: Allows to interact with the Task Scheduler cluster.
  • UICustomization: Allows users to save UI view layout in custom views.
  • UserPermissions: Manages users and roles.
  • NeosSharedUI: Adds basic components.

Installation

To use one or more of these modules, add them under the ReferencedModules section in your cluster configuration. Detailed instructions on consuming packages can be found in this article.

ReferencedModules:
  NeosAICore: [NEOS_VERSION]
  NeosCore: [NEOS_VERSION]
  NeosDashboard: [NEOS_VERSION]
  NeosDataExchange: [NEOS_VERSION]
  NeosNotificationCenter: [NEOS_VERSION]
  Onboarding: [NEOS_VERSION]
  TaskSchedulerClient: [NEOS_VERSION]
  UICustomization: [NEOS_VERSION]
  UserPermissions: [NEOS_VERSION]
  NeosSharedUI: [NEOS_VERSION]
  NeosEmailReception: [NEOS_VERSION]
  NeosAIMail2Entity: [NEOS_VERSION]

In this configuration, replace [NEOS_VERSION] with the specific version of Neos your cluster is using. It’s essential to ensure the version of these modules matches your Neos framework version. When updating Neos, remember to update these modules accordingly.

Example:

ReferencedModules:
  NeosAICore: 2.3.0
  NeosCore: 2.3.0
  NeosDashboard: 2.3.0
  NeosDataExchange: 2.3.0
  NeosNotificationCenter: 2.3.0
  Onboarding: 2.3.0
  TaskSchedulerClient: 2.3.0
  UICustomization: 2.3.0
  UserPermissions: 2.3.0
  NeosSharedUI: 2.3.0
  NeosEmailReception: 2.3.0
  NeosAIMail2Entity: 2.3.0

NuGet Package Source

These modules are hosted on the NuGet Neos package source. To access them, you need to have the dependencies.nuget.config file within your cluster's modules directory.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear />
    <add key="Neos-FMK-Modules" value="https://pkgs.dev.azure.com/POLE-ERP-GROUPEISA/Neos-Public/_packaging/Neos-Public/nuget/v3/index.json" protocolVersion="3" />
  </packageSources>
</configuration>