Portal Config

danger

This is a concept that has been under development, conceptually for some and there are some code supporting the concept. the following section is supporting portal by config concept but not yet fully implemented.

Overview

The Portal module defines the structure and types related to the state of a portal within the system. This documentation outlines the properties and their functionalities within the Portal and ContextType types.

export type Portal = {
    id: string;
    icon?: string;
    name: string;
    shortName?: string;
    subtext?: string;
    contexts?: ContextType[];
};

export type ContextType = { type: string };

Portal Type

The Portal type represents the state of a portal within the system. It consists of the following properties:

Properties

1. id: string (required) - Description: Unique identifier for the portal.
2. icon: string (optional) - Description: URL or reference to the icon associated with the portal.
3. name: string (required) - Description: The name of the portal.
4. shortName: string (optional) - Description: A shorter version or abbreviated name of the portal.
5. subtext: string (optional) - Description: Additional descriptive text or subtext for the portal.
6. contexts: ContextType[] (optional) - Description: An array of context types associated with the portal.

Usage

• The id property serves as the unique identifier for each portal and is crucial for distinguishing between different portals.
• The name property represents the name of the portal, providing a recognizable label for the portal header.
• The icon, shortName, and subtext properties offer optional additional information or visual elements to enhance the user experience.
• The contexts property allows for associating the portal with specific context types, providing additional context or categorization.

ContextType Type

The ContextType type represents the various contexts associated with a portal.

Properties

1. type: string (required)
   • Description: Type of context associated with the portal.

Usage

• The type property specifies the type of context associated with the portal.
• This type is used within the contexts property of the Portal type to categorize or provide additional context to the portal.

Examples Configuration

{
    "id": "5b43c3fd-77e3-4072-0aa1-08db310ee26d",
    "icon": "fusion.log.svg",
    "name": "Project Portal",
    "shortName": "PP",
    "subtext": "The application is designed to provide a comprehensive display of fusion applications, tailored to the selected context and context type. By scoping the displayed applications, users can gain a better understanding of the available options.",
    "contexts": [{ "type": "Facility" }, { "type": "ProjectMaster" }]
}

This example json demonstrates how to a portal may be define with various properties and associate it with specific context types.

The Portal State config provides a clear definition of the Portal and ContextType types, allowing to manage and utilize portal-related data effectively within the system. By understanding the properties and usage of these types, developers can create and manipulate portal states with ease.

Governance

Governance regarding portal configuration involves establishing rules and protocols to manage how the portal is set up and maintained. It includes defining who has access to configure the portal, what changes can be made, and ensuring compliance with relevant policies and standards. Effective governance helps maintain consistency, security, and usability of the portal while aligning with organizational goals and objectives. While this is important, the concept portal by config is still too new to think about governance at the moment.