ComUnity Digital Service Delivery Platform

The ComUnity Digital Service Delivery Platform is a comprehensive solution that provides organisations with the tools, templates, and infrastructure they need to build, deploy, and manage digital solutions, products and services. The platform is designed to be highly flexible, scalable, and secure, making it well-suited for organisations of all sizes and industries.

The platform falls into an emerging technology area called Platform Engineering. It aggregates many disparate elements of a digital solution and reduces technical complexity. Platform engineering is a new socio-engineering concept that straddles team structure and the engineering discipline behind it to build scalable and resilient digital platforms. The old way of development teams not communicating with each other and doing whatever they want is now replaced by teams all working on a unified platform.

Benefits of platform engineering

Platform engineering allows an autonomous delivery team to use the platform to deliver new product features at a higher pace, with reduced coordination. Other benefits are:

• Encourages innovation and creativity

• Rapid implementation

• Faster time-to-value

• Governance is baked-in

• Manages all end-to-end business processes

• Reduced cost of development

• Improves engagement between IT and business stakeholders

• Standardised user experience

• Ease of maintenance

ComUnity Core and Processes

ComUnity has a data-centric intelligent core, connecting external stakeholder experiences with internal systems and processes.

The ComUnity Platform Engineering Model

The model adopted by the ComUnity Platform comprises three layers:

The Cloud Infrastructure Layer provides organisations with the underlying base cloud infrastructure and services that are necessary to build, deploy, and manage the higher layers of digital products and services.

Many large and complex organisations may choose to assemble “Platform Engineering” teams who build out such an internal platform from scratch. However, the ComUnity Rapid Digitisation Platform contains all the complex platform engineering capabilities out-of-the-box thus removing the need to build out such a platform from scratch. The broad capabilities provided by ComUnity include:

• Base Platform Architecture/Core: the digital foundation required to build an internal Digital Platform.

• Reusable Components: the digital building blocks required to build an internal Digital Platform.

• Platform Developer Toolkit: the developer tools and SDKs required to build an internal Digital Platform.

• Internal Developer Portal: the self-service capabilities required to operate an internal Digital Platform.

Digital Service Delivery Teams are the multidisciplinary, compact, co-located, and empowered development teams which build real value adding services and applications on top of the ComUnity Platform Instance. They do this buy leveraging the capabilities of the ComUnity Rapid Digitisation Platform layer.

ComUnity Provides a Paved Road

Digital platforms built on the principles of platform engineering offer the concept of a “paved road.” This avoids the complex processes and standards of traditional development, implementation and maintenance. Instead, it provides optimised processes developed using accepted best practices and processes, pre-defined tools, and development languages.

The General tab in Project Settings displays key project properties, including the Application Name, Application Namespace, Organisation Name, Creation Date, Last Modified Date, and Application Title.

Key Features

• Application Name: Displays the current name of your application. This name is normally used when referring to the code dynamically in the source code for customisations and is immutable.

• Application Namespace: Shows the namespace associated with your application.

• Organisation Name: Indicates the name of the organisation linked to the project.

• Created: Shows the date and time when the project was created.

• Last Modified: Displays the date and time of the last modification made to the project.

• Application Title: Allows you to modify the title of your app. When you create a project, the name you set during the project creation process becomes the default title of your app. The General section offers an opportunity to create a new title distinct from the project name. This flexibility allows you to tailor the app title to better reflect its purpose or branding without altering the project's original name.

Access Project Settings

1. Login to the ComUnity Developer Toolkit

2. Select your Project: From the dashboard, select the project you wish to manage.

3. Open Project Settings: After opening your project in the Toolkit, access Project settings by clicking the cog icon with the tooltip "Project settings" (as shown below).

Customise the Application Title

1. Select General Settings: In the Project Settings menu, click on the "General" option.

2. Locate Application Title: In the General settings section, find the "Application Title" field.

3. Enter New Title: Click on the text field next to "Application Title" and enter your desired new title.
4. Save Changes: After entering the new title, click the "Save" button to apply the changes.

The Manage Your Account menu provides quick access to essential options for managing your profile, updating account settings, and performing key actions. From here, you can customise your personal details, change your password, clear the application cache, and securely sign out. This menu ensures users have effortless control over their account and related actions.

Profile

The Profile section allows users to view and edit their profile details. Users can update their name, surname, cell number, email, company name, company role and avatar.

To access Profile settings, follow these steps:

1. Navigate to the 'Profile' tab in the account settings.

2. Click the 'Edit your profile details below' button.

3. Update the desired fields: Name, Surname, Cell, Email, Company Name, and Company Role.

4. Click 'Save' to apply the changes.

Account Settings

Account Settings provides a shortcut to an interface with the detailed Accounts section which contains subsections Profile, Change Password and Notification Settings.

Change Password

The Change Password section allows users to update their account password.

To access Change Password, follow these steps:

1. Navigate to the 'Change Password' tab in the account settings.

2. Enter your current password (if required).

3. Enter the new password in the 'New password' field.

4. Click 'Change password' to update your password.

Clear Application Cache

The Clear Application Cache option allows users to clear the stored cache data in the application.

To Clear Cache of you application, follow these steps:

1. Click on your avatar in the top-right corner of the application.

2. Select 'Clear application cache' from the dropdown menu.

3. Confirm the action if prompted to clear the cache.

Sign Out

The Sign Out option allows users to securely log out of the application.

To Sign Out, follow these steps:

1. Click on your avatar in the top-right corner of the application.

2. Select 'Sign out' from the dropdown menu.

3. You will be redirected to the login screen after signing out.

The ComUnity Developer Toolkit enables developers to customise the appearance of their applications across client platforms, including Android, iOS, Web, and Windows, using themes. A theme is a collection of attributes that define the style and layout of the application, providing flexibility to align the app’s design with branding and user preferences.

Themes offer extensive customisation options, allowing developers to modify components such as tabs, buttons, text size, and label appearance:

• Tabs: Developers can customise tab colours, including background and font colours, to align with the app’s design language and branding.

• Buttons: Adjust button attributes like background colour, font colour, and visual feedback to seamlessly integrate with the app’s overall aesthetic.

• Text Size: Tailor font sizes to enhance readability and support accessibility across devices and screen sizes.

It's important to note that the availability of customisation options may vary depending on the platform. For example, in mobile app development, developers may have the option to modify the accent colour, which is a platform-specific customisation feature.

By leveraging these capabilities, developers can create visually appealing interfaces that enhance usability and cater to diverse user needs. Themes ensure that the app maintains consistency across platforms while accommodating specific design and branding requirements.

Supported clients include:

Accessing and Customising Themes in the ComUnity Developer Toolkit

To customise the appearance of your app across different client platforms, the Themes feature in the Toolkit provides developers with a convenient interface. Themes allow you to modify attributes and properties of various components, such as tabs, buttons, text size, and label appearance. This guide will walk you through accessing the Themes interface and provide an overview of its layout and functionality.

Accessing Themes in the Toolkit

To access Themes in the Toolkit and begin customising your app's appearance, follow these simple steps:

1. Login to the ComUnity Developer Toolkit

2. Select your Project: From the dashboard, select the project you wish to manage.

4. Tab View of Supported Clients: Upon selecting the Themes tab, you will be presented with a tab view layout. Each tab represents a supported client platform, such as Android, iOS, Web, and Windows. The tab view allows you to navigate between different clients to customise their specific appearance.

Layout and Customisation Options

Once you've accessed the Themes interface, you will find a user-friendly layout that simplifies the customisation process. Here are some key aspects of the interface:

• Tab View Menu: The tab view menu presents each supported client as a separate tab. This enables you to focus on customising the appearance of the app for a specific platform. Simply click on the desired tab to access the corresponding customisation options.

• Attributes and Properties: Within each client tab, you will find relevant attributes and properties that can be modified. These options may include colour schemes, font styles, sizes, and other visual settings. All colour attributes are equipped with a built-in colour picker, which supports both selection from a colour palette and manual input of hexadecimal colours.

• View More Attributes: In some cases, you may find that the initial view of attributes is condensed to provide a streamlined interface. If you require additional customisation options, you can click on a More Attributes option to expand the tab view. This allows you to access and modify a wider range of settings to refine the app's appearance.

• Save: Once you have made the desired changes to the attributes and properties, clicking on the Save button will save the modifications. This ensures that your customised settings are applied to the app, reflecting the desired appearance for the selected client platform.

By utilising the intuitive interface of the Themes feature, developers can easily navigate through the supported client tabs, modify the relevant attributes, and create visually appealing and consistent user interfaces for their apps.

In conclusion, accessing and customising Themes in the Toolkit involves navigating to the project settings, selecting the Themes option, and exploring the tab view layout for each supported client platform. With the ability to modify various attributes and properties, including the use of a built-in colour picker, developers can easily customise the appearance of their apps to match branding, enhance usability, and create a personalised user experience.

Supported Attributes in Each Client Platform

In this section, we will provide an overview of the supported settings in the ComUnity Platform that can be customised for each client platform. These settings allow you to modify various aspects of your app's appearance and behaviour to create a unique and engaging user experience that aligns with your brand and audience.

Google Android

Basic Settings

When creating a new project, the primary and accent colours can be selected from the dialog. These colours will be used as shown below, with suitable values set for the additional values. These values can be changed as required.

More attributes

The following settings will use the specified default value if not value is set. The values can be overridden if required.

Additional Resources

iOS

WEB

Windows

The ComUnity Toolkit empowers project administrators with a robust and intuitive user role and permission management system, designed to streamline project governance and enhance security. With this feature, administrators can easily control the actions individual users can perform on specific data entities, based on predefined permission rules.

At the core of this functionality is the Data model, which serves as the foundation for permission control within entities. When users register in your application, their default user role is set as User. However, project administrators have the flexibility to customise user access and capabilities by assigning them to one of the three default user roles: Administrator, Staff, or User. Moreover, the ComUnity Toolkit provides the capability for administrators to define custom user roles to cater to specific project requirements.

Each role, whether default or custom, provides a starting point for permissions. However, the specific permissions for each role are configured and customised using the Table Security feature. This allows project administrators to have granular control over user access at the entity level. With Table Security, you can define and manage permissions for specific entities within your project. By selecting from a list of supported roles and customising the CRUD permissions (Create, Read, Update, Delete) for individual entities, you can finely tune the access and actions that users can perform, enhancing security and control.

Additionally, the user management utility in the ComUnity Toolkit allows administrators to delete users and reset user passwords. This ensures efficient management of user accounts and enhances security protocols within your project.

By leveraging the Data model, supported roles, Table Security, and the user management utility, you can effectively manage user permissions, account deletion, and password resets to align precisely with your project's specific requirements. This flexibility empowers you to grant or restrict access at both the data and entity levels, ensuring that users have the appropriate access and capabilities within your project while maintaining data integrity and security. Whether utilising the default user roles or creating custom roles, the ComUnity Toolkit offers a comprehensive permission control system to meet the diverse needs of your project.

The Manage Users section provides a comprehensive set of instructions on how to effectively manage user accounts within the ComUnity Toolkit. As a project administrator, you have the ability to view users, delete user accounts, and reset passwords, empowering you to maintain control over user access and enhance security protocols.

To effectively manage users in your project, follow these steps:

1. Login to the ComUnity Developer Toolkit

2. Select your Project: From the dashboard, select the project you wish to manage.

4. Access Environment Settings: In the Project Settings panel, navigate to the top section where environment tabs are displayed. You will see options for Global, Development environment, QA environment, and Production environment. Click on the relevant environment tab to access its specific settings.

5. Open the App Users & Roles Panel:

   • In the left sidebar, select App Users & Roles to manage user access.

   • The panel provides three tabs:

     • Users – Manage registered users.

     • Roles – Assign and define roles.

     • Credentials – Configure authentication settings.
6. Manage Users

   • Within the App users & roles tab, you will find three sub-tabs: Users, Roles, and Credentials. The initial tab labelled as Users, shows a comprehensive list of all registered users in your application, if any exist.
   • To delete a user, locate the user in the list and click on the trash icon or delete button associated with that user - functionality currently disables.

   • To add a new user role to an existing user:

     1. Locate the user in the list a, click on the green plus icon. This will open a modal where you can assign user roles.

     2. Select the appropriate role for the new user from the available options.

     3. It's important to note that a user can have multiple roles, granting them different levels of access and permissions within your project.

Throughout the process, you will find helpful tooltips associated with each button, providing a brief description of their functions. This ensures a seamless user experience and helps you navigate the user management system with ease.

By following these steps, you will be able to efficiently manage users, assign roles, and maintain control over user access and permissions within your project.

Manage User Roles

In the ComUnity Toolkit, you have full control over managing user roles to precisely define access and permissions for different users within your project. By default, the Toolkit provides three pre-defined roles: Administrator, Staff, and User.

Here's a step-by-step guide on how to manage user roles:

1. Login to the ComUnity Developer Toolkit

2. Select your Project: From the dashboard, select the project you wish to manage.

4. Access Environment Settings: In the Project Settings panel, navigate to the top section where environment tabs are displayed. You will see options for Global, Development environment, QA environment, and Production environment. Click on the relevant environment tab to access its specific settings.

5. Open the App Users & Roles panel: Click on the Roles tab to manage user roles. Here, you will find the default roles: Administrator, Staff, and User.

1. To add a custom role, locate and click the Add Role button.

2. A dialog box will appear, allowing you to enter the name of the new role.

3. If you need to remove an existing role, click on the corresponding delete icon next to the role you wish to delete.

4. A confirmation prompt will appear, ensuring you want to proceed with the deletion. Confirm the action if you are certain about removing the role.

By managing user roles effectively, you can precisely define the access privileges and permissions granted to different users, allowing for efficient project governance and enhanced security.

The ability to create custom roles enables you to tailor user access and permissions to meet the specific requirements of your project, ensuring a personalised and secure user experience.

Manage Authentication Credentials

Authentication in ComUnity Development Toolkit is an integrated service which provides functionality to create and manage user accounts/profiles, securely store personal user data(passwords and emails) and also to validate and verify user credentials when users access resources in your applications. In the ComUnity Toolkit, user registration and authentication are handled by two entities: Auth and UserProfile. The Auth entity is responsible for managing authentication-related properties such as AuthId, CellNumber, Password, NewPassword, ConfirmPassword, Name, Surname, and OTP. On the other hand, the UserProfile entity focuses on user profile information, including properties like Id, Cell, Name, Surname, Email, StreetAddress, ContactByEmail, ContactByPush, and Photo.

To ensure secure authentication and user data management, the ComUnity Toolkit follows best engineering practices. It leverages technologies such as JSON Web Tokens (JWT) for authentication, which provide a secure and efficient method for verifying user identity. Additionally, all user data stored within the UserProfile entity is encrypted to protect sensitive information and maintain data integrity.

By utilising these technologies and implementing strong security measures, the ComUnity Toolkit ensures that user registration and authentication processes are robust and follow industry-standard practices. This approach safeguards user privacy and helps maintain a secure environment for user interactions within the toolkit.

When you build your projects in the ComUnity Development Toolkit, the system will create a fully featured authentication service which can be visualised and customised through specific data entities and their corresponding editing pages.

Configuring Rule Sets for Authentication Credentials

In the ComUnity Development Toolkit, you have the flexibility to configure custom Rule Sets for validating authentication credentials. These Rule Sets are enforced during Server Side Form Validation when receiving HTTP requests from the client. This feature allows you to define specific validation rules and customise error messages for authentication credential validation failures.

To configure Rule Sets for authentication validation, follow these steps:

1. Login to the ComUnity Developer Toolkit

2. Select your Project: From the dashboard, select the project you wish to manage.

4. Access Environment Settings: In the Project Settings panel, navigate to the top section where environment tabs are displayed. You will see options for Global, Development environment, QA environment, and Production environment. Click on the relevant environment tab to access its specific settings.

5. Open the App Users & Roles panel: Click on the Credentials tab to manage app authentication credentials. Here, you will find a preselected list of authentication credentials, such as Cell, Email, and Plain.
6. To add more credentials, locate and click the Add Rule Set button.

7. Select a credential from the list to configure its authentication validation rules as as configuration properties.

   • LoginMinLength: Specifies the minimum number of characters required in a valid username (account name, email address, or mobile number) used during authentication.

   • LoginMinLengthMessage: Defines a custom error message to display when the LoginMinLength check fails.

   • PasswordMinLength: Specifies the minimum length of the plain text password (before encryption).

   • PasswordMinLengthMessage: Defines a custom error message to display when the PasswordMinLength is invalid.

   • PasswordMinCapitalLetterCount: Specifies the minimum number of capital letter characters required in a valid password.

   • PasswordMinCapitalLetterCountMessage: Defines a custom error message to display when the PasswordMinCapitalLetterCount rule is broken.

   • PasswordMinSmallLetterCount: Specifies the minimum number of lowercase letter characters required in a valid password.

   • PasswordMinSmallLetterCountMessage: Defines a custom error message to display when the PasswordMinSmallLetterCount rule is broken.

   • PasswordMinNumericCount: Specifies the minimum number of digits required in a valid password.

   • PasswordMinNumericCountMessage: Defines a custom error message to display when the PasswordMinNumericCount rule is broken.

   • PasswordMinNonalphanumericCount: Specifies the minimum number of non-alphanumeric characters required in a valid password.

   • PasswordMinNonalphanumericCountMessage: Defines a custom error message to display when the PasswordMinNonalphanumericCount rule is broken.

   • PasswordReuseProhibitCount: Specifies the number of times a user can change their password before they are allowed to reuse a previous password.

   • PasswordLifetimeDays: Specifies the lifetime of a valid password credential in days.

   • PasswordLifetimeDaysMessage: Defines a custom error message to display when the PasswordLifetimeDays has expired.

   • MaxFailedLogins: Specifies the maximum number of failed login attempts permitted before a user account is locked.

   • PinSlidingWindowSecsMessage: Defines a custom error message to display when the authenticated session is invalid due to the expiration of the PinSlidingWindowSecs window.

   • PasswordIntruderDelaySecs: Specifies the time in seconds a user has to wait between two successive login attempts in case of suspicious login activity.

   • PasswordIntruderDelaySecsMessage: Defines a custom error message to display when login fails due to enforced delay between successive login attempts by platform intruder detection.

   • PinRequiredMessage: Specifies a custom error message to display on the client, indicating that a One Time Password (OTP) is required.

   • SmsPinRazorTemplate: Allows you to create an SMS template for sending One Time Passwords (OTP) using Razor Pages.

   • DisableAutoRegistration: Disables the automatic creation of a default UserProfile record when logging in for the first time.

By configuring these Rule Sets, you can ensure that authentication credentials adhere to the defined validation rules and enhance the security of your application.

The ComUnity Toolkit offers a robust, role-based settings system designed to manage various project specific settings. Understanding these settings is crucial for effective management and configuration. For more detailed information, refer to the relevant sections within Project Settings.

The new consolidated Project Settings section, with configurations now organised into the following tabs:

1. Global Tab:

   This tab includes settings applicable across all environments, such as:
2. Environment-Specific Tabs:

   Separate tabs are available for managing configurations specific to each environment:

Each environment tab includes the following settings:

• Reports

These tabs clearly differentiate between global and environment-specific settings, streamlining navigation and configuration management. Some features, such as Communications, may require management at both the global and environment levels.

Benefits of the Unified Structure

• Centralised Management: Project-related and environmental configurations are now accessible from a single location.

• Improved Usability: The consolidated structure simplifies the process of configuring and updating settings, reducing the effort required for navigation and management.

Icons are essential UI elements that visually represent functions, features, and commands in applications. In the ComUnity Developer Toolkit, the Icon Management feature allows developers to browse system icons, upload custom icons, and organise them for easy retrieval and implementation.

Developers can also upload custom icons, allowing them to integrate unique branding elements and design icons tailored to their application’s needs.

This guide covers how to browse, add, and use icons in your projects.

Browse Icons

To browse system and custom icon libraries in an existing project in the Toolkit, follow these steps:

1. Login to the ComUnity Developer Toolkit

2. Select your Project: From the dashboard, select the project you wish to manage.

4. You can also access Legacy icons from previous Toolkit versions.
5. Click Details to view system icons in the corresponding library.

Adding a Custom Icon Library

Enrich the visual vocabulary of your applications by adding custom icons to the Toolkit. This section details the process for uploading and managing your custom icons within the Toolkit, ensuring they are optimised for performance and scalability.

To add a icon/icon library to an existing project in the Toolkit, follow these steps:

1. Go to Project Settings > Icons.

3. Click the Add Icon tile to navigate to the Add a Custom Icon Library screen:
4. Click the Add SVG files button to upload your icon files from your local machine in the screen showed below:

   When adding a custom icon library, you can upload individual SVG files or a ZIP file containing SVG files. The upload function will recursively search the ZIP file structure for all SVG files and ignore any files with duplicate names.
5. In the screen that appears, specify the following details for your icon or icon library:

   • Icon library name: Enter a name for your icon library.

   • Style: When incorporating a library, the default Style is set to regular. However, you have the flexibility to customise this. To select a different style, simply use the dropdown menu provided. If your needs extend beyond the available options and you wish to define a unique style, you can easily do so by entering a new name in the designated field.

   • Drag and drop SVG files: Drag and drop the SVG files for your icon or icon library from your local machine.

6. After adding your icon files, you can preview and categorise your icons.

7. Check the box next to I have an active license that gives me permission to use these icons.

8. Finally click the Add icon library button.

Manage Custom Icon Libraries

This section delves into the comprehensive management of custom icon libraries within the Toolkit. Developers can effortlessly add, categorise, and tag their own icon sets, ensuring effortless retrieval and organisation. Moreover, it provides the ability to preview icons to verify their alignment with design goals and enables downloading for seamless integration into applications. By harnessing these functionalities, developers can craft a unified and personalized visual language across their projects, ensuring that each icon not only fulfills a functional purpose but also harmoniously contributes to the overall aesthetic and user experience.

Categorising and Tagging Icons

Effectively organising and tagging your icon sets is essential for effortless retrieval and seamless integration into your projects. This section provides comprehensive instructions on categorising and tagging your icons within the library, empowering you to enhance icon manageability and streamline your design workflow.

Selecting Icon

1. Go to Project Settings > Icons.

3. To select a custom icon library, click the Details button located within the corresponding tile. This action will display all icons contained within that specific library on your screen.

4. Once you've located the desired icon, simply click on it to select it. The selected icon's properties will be displayed on the right-hand side of the screen for further customisation.

Adding a Tag

1. To tag an icon, click the (+) icon located next to the tag section.

2. Enter the desired tag name in the field that appears.

3. Confirm and save your tag by clicking the checkmark icon.

4. You can click the (x) mark to remove a tag

Adding a Category

1. For categorisation, click the (+) icon adjacent to the category section.

2. Choose a suitable category from the provided dropdown menu.

3. Finalise your selection by clicking the checkmark icon to save the category.

4. You can click the (x) mark to remove a category.

By following these straightforward steps, you can efficiently categorise and tag your icons, significantly enhancing the organisation of your library. This process not only streamlines the retrieval of icons but also facilitates their implementation into various aspects of your project, promoting a more efficient and streamlined design workflow.

Previewing Icons

After selecting a Custom Icon Library and clicking the Details button, you will be presented with a comprehensive view of all icons contained within that specific library. This allows you to preview each icon in detail, ensuring it aligns with your design vision and project requirements. To preview an icon, simply click on it. The selected icon will be displayed in a larger format, providing a clear view of its details and ensuring it seamlessly integrates with your project's aesthetic and functionality.

Downloading Icon Sets

Once you've identified the target icon for your project, you can effortlessly download it for immediate use. To download an icon, simply click the Download button located in the Preview. The selected icon will be downloaded in the appropriate format.

Expanding Your Icon Collection: Adding Icons to Custom Icon Sets

As your design needs evolve, you may find that your existing custom icon sets require additional icons to fully support your project's visual language. The Toolkit's intuitive interface makes it easy to seamlessly add new icons to your existing custom icon sets, ensuring that you have the right icons at your fingertips to bring your design vision to life.

To add icons to a custom icon set, follow these steps:

1. Navigate to Project Settings > Icons and locate the desired custom icon library.

2. Once you've identified the target library, click the Details button located within the corresponding tile. This action will display all icons contained within that specific library on your screen - icon gallery

Implementing Icons in Your Application

1. Locate the list or main menu Item where you wish to implement the icon.

2. Upon selection, an Icon setting option will appear in your Property Settings, granting access to the icon configuration tools.
3. Click on the (+) icon to reveal the icon editor, a dedicated space for selecting and customising your icons.
4. Choose the desired icon library. The Toolkit selects Bootstrap icons by default, if Bootstrap does not align with your requirements, explore alternative libraries provided within the Toolkit.

5. Browse the selected library and locate the icon that best suits your needs.

6. Once you've selected your icon, click Use Icon to apply your changes.

7. Finally click Save to persist your changes, the chosen icon will now be integrated into your list, enhancing the user interface.

The ComUnity Developer Toolkit enables you to manage app versioning for iOS, Android and Windows applications using the following convection:

x.y.z

Whereby:
- x,y and z are dot seperated digits and,
- x denotes the major, y denotes the minor and z denotes the build.

When you change the major or the minor, your users will receive an in-app notification prompting them to upgrade to the latest version.

Set application version information

To set up your app version information, follow these steps:

1. Login to the ComUnity Developer Toolkit

2. Select your Project: From the dashboard, select the project you wish to manage.

4. Navigate to Versions: In the Project Settings menu, click on the "Versions" option.
5. Specify the version in the Android Version(x.y.z), IOS Version(x.y.z) and the Windows Version(x.y.z) boxes where it is applicable.

6. Specify the relevant urls of your app in the Google Store URL, Apple Store URL and Microsoft URL boxes.

7. Describe the relevant change details in the Android Version, IOS Version and the Windows Version boxes.

8. Once completed, click Save to apply the updated app version information.

Overview

The ComUnity Developer Toolkit is a comprehensive platform that simplifies the creation of multi-sided digital platforms for developers. It sets itself apart by offering a single design interface and a powerful Low-Code Rapid Development Interface that not only streamlines the development process but also enables developers to build platforms faster and more cost-effectively compared to traditional manual coding methods. With its unmatched speed, the ComUnity Developer Toolkit empowers developers to bring their digital platforms to life rapidly, giving them a competitive edge over other development tools in the market.

Key Feature of the ComUnity Developer Toolkit

The ComUnity Developer Toolkit offers a crucial advantage by enabling developers to build their projects efficiently across multiple platforms. This unique capability eliminates the need for separate development efforts for each target platform and significantly reduces redundant tasks.

With the Toolkit, the development phase begins by building the web version of your project. This initial focus provides a visual representation of your project and facilitates testing during development. While working on the web version, you also have the option to set up properties and configurations specific to other client applications within the Toolkit.

To adapt your project for different clients, such as iOS, Windows, and Android, you can utilise the Toolkit's features to define properties and settings unique to each platform. These properties can include platform-specific design elements, device capabilities, or integrations with native features.

By setting up these properties within the Toolkit, you ensure that the generated client applications align with the respective platform requirements. This allows for a seamless and optimised user experience across different devices and operating systems.

Additionally, the Toolkit provides a streamlined workflow for managing the variations between client applications. You can efficiently update and maintain your project by making changes within the Toolkit, which then propagate to all the generated client applications, ensuring consistency and reducing development overhead.

By offering this level of flexibility and customisation, the ComUnity Developer Toolkit empowers developers to efficiently build projects for multiple platforms while maintaining a unified codebase and reducing time and effort spent on redundant development tasks.

The Toolkit supports the end-to-end Digital Project Lifecycle Management, covering the following phases:

• Plan: Within the Toolkit, you can create the high-level requirements for your digital project and design the overall project structure.

• Code: Utilise the Toolkit's development tools, such as the built-in code editor or integration with external tools like Visual Studio, to write the necessary code for your digital project.

• Build: Automated build tools provided by the Toolkit assist in building the required server components and native client applications directly from your code.

• Test: Use the Toolkit's testing capabilities to run tests on the latest builds and ensure the functionality of your digital project.

• Release: Prepare the code and other project assets within the Toolkit for release, making them ready for deployment.

• Deploy: Take advantage of the Toolkit's automated deployment tools, which assist in deploying the builds from development to quality assurance (QA), staging, and production environments.

• Operate: Integrate the Toolkit into server environments to effectively manage the deployment and operation of ComUnity digital projects, ensuring smooth execution and performance.

• Monitor: The Toolkit provides ongoing system health monitoring and allows you to monitor all components of the digital ecosystem, ensuring optimal performance and identifying any potential issues.

By offering an intuitive and streamlined development experience, the ComUnity Developer Toolkit empowers developers to create compelling multi-sided digital platforms efficiently and effectively.

ComUnity Digital Services Development Life Cycle

The ComUnity Developer Toolkit provides a comprehensive software development life cycle for building digital services. This development life cycle encompasses the following phases:

1. Create a new Project:

   • Begin by creating a new project within the Toolkit, setting the foundation for your digital service development.

2. Define Metadata and Authorization:

   • Define the necessary metadata and authorisation settings for your application within the Toolkit. This includes specifying data structures, user roles, permissions, and authentication mechanisms.

3. Integrate with External Services:

   • Seamlessly integrate your digital service with external services or APIs by leveraging the integration capabilities of the Toolkit. This enables your application to communicate and interact with third-party systems.

4. Build Communication Services:

   • Utilise the Toolkit's features to build communication services within your application. This includes implementing functionalities such as messaging, notifications, real-time updates, and data synchronisation.

5. Build Client Applications:

   • After completing your project within the ComUnity Developer Toolkit, you have the option to enlist the assistance of the ComUnity Team to build client applications for each supported platform.

6. Deploy to Dev/QA/Production Servers:

   • Once the development phase is complete, deploy your application to development, quality assurance (QA), and production servers using the deployment tools provided by the Toolkit. This ensures a controlled and organised release of your digital service.

In addition to the development life cycle, the ComUnity Developer Toolkit offers a range of configurable components. These components can be customised and tailored according to your specific application requirements. The diagram below illustrates the various components that you can configure when utilising the Toolkit:

By following this comprehensive software development life cycle and leveraging the configurable components of the Toolkit, developers can efficiently create and deploy robust digital services across multiple platforms.

Overview

1. Shared Multi-Tenancy Environment:

https://toolkitnxt.comunity.me/

This environment is often used for testing or as part of a multi-tenancy organisational license.

2. Single-Tenancy Deployment:

For organisations with dedicated Toolkit instances, use the unique URL provided by your administrator. Single-tenancy deployments are hosted in isolated environments for enhanced security and customisation.

Password-based Authentication

Password-Based Authentication is the default login method for users in both shared and single-tenancy deployments. It enables users to securely access the Toolkit using a unique username and password combination provided during registration.

If you are a registered Toolkit user and your registration request has been approved, you can log into the Toolkit using your provided credentials. Upon successful login, you will be directed to the Home Screen, where you can access the Toolkit’s features and functionalities.

Registration

To create a new user account in the ComUnity Platform, please follow these steps:

1. From the Home Screen, click on Request Access.

2. You will be directed to the Request Access screen.

3. Complete the Request Access form by providing your relevant details.

4. Finally, click on the Register button to submit your account request.

Ensure accurate and complete information to expedite the account creation process.

Password Reset

To reset your password, follow these steps:

1. Go to the login screen of the ComUnity Developer Toolkit, as instructed above.

2. Click Forgotten your password?

3. Enter your username.

4. For security purposes, the ComUnity platform will need to verify your identity before you can proceed with resetting your password. You will receive a one-time password (OTP) via your preferred channels, if available. Otherwise, it will be sent to the main channel associated with your registered account (e.g., email or SMS).

5. Retrieve the OTP.

6. Enter your new password and OTP in the relevant fields provided.

7. Click Reset Password.

Microsoft Entra Login

• Unified Authentication: Supports both user and partner sign-ins.

• Enterprise-Grade Security: Utilises OAuth 2.0 and OpenID Connect protocols.

Limitations

Steps to Sign In with Microsoft Entra

2. Open your organisation’s Toolkit instance URL (e.g., https://yourorg.domain).

3. On the login screen, click Login with Microsoft. You will be authenticated and automatically redirected to the Toolkit’s Home Screen upon successful login.

The Store URLs section under Project Settings allows developers to configure app store URLs (Google Play Store, Apple App Store, Microsoft Store) associated with the native mobile and desktop apps generated from their projects. The Toolkit enables building web, native mobile apps, and Windows desktop apps from the same code base. This section enhances user experience by ensuring that when users visit the web app on their mobile devices, they are redirected to the relevant app store for downloading the native app, achieved through deep linking. Similarly, if users visit on a desktop and a Windows app is available, they can be redirected to the Microsoft Store. This functionality is only active if the other variants of the app, aside from web, are supported. To request an app, please contact the ComUnity team.

Key Features

• View URLs: Displays the current app store URLs configured for your project's app variants.

• Add/Edit URLs: Provides options to add new app store URLs or edit existing ones to ensure your apps are correctly linked to their respective stores.

Managing Store URLs

To manage the app store URLs associated with your project's hybrid mobile apps, follow these steps:

2. Navigate to Store URLs: In the Project Settings menu, click on the "Store URLs" option.
3. View Current URLs: The section will display the current app store URLs associated with your project's hybrid mobile apps.

4. Add/Edit URLs: Use the provided options to add new app store URLs or edit existing ones as needed.

5. Save Changes: Ensure any changes made are saved to update the configuration.

By following these steps, you can easily manage the app store URLs for your project's hybrid mobile apps, ensuring that all components are correctly configured for automated deployments.

Configuration serves as a centralised configuration management system within the ComUnity Platform, designed to streamline the management of settings across different deployment environments—Development, QA/Testing, and Production. Its primary function is to provide an overview and control mechanism for the settings within each project's environment, enhancing consistency and simplifying the management process.

Key Features

• Centralised Overview: Configuration offers a unified view of your project's settings across all environments, enabling easy monitoring and adjustments without the need to access each environment separately.

• Environment-Specific Configuration: It allows for the distinction and management of environment-specific settings, ensuring that configurations are appropriate and tailored for each stage of the deployment process.

• Simplified Management: By centralising configuration settings this reduces the complexity of managing multiple environments, enabling you to change settings from one central location.

• Cross-Environment Visibility: Gain insights into how settings are configured across Development, QA, and Production environments, facilitating a better understanding and quicker identification of configuration discrepancies.

Configuration is an integral tool for maintaining the integrity and consistency of your project's configuration, ensuring that each environment is optimally set up for its intended purpose. Whether you're diagnosing an issue or implementing new features, Configuration provides the necessary infrastructure to manage your configurations efficiently and effectively.

Manage settings on Configuration

Configuration simplifies the management of your project's settings, offering a user-friendly interface where you can edit, secure, or remove configuration details efficiently. This centralised approach not only enhances the manageability of your configurations but also promotes consistency across different environments. To manage Configuration settings in your project, follow these steps:

1. Login to the ComUnity Developer Toolkit

2. Select your Project: From the dashboard, select the project you wish to manage.

4. Access Environment Settings: In the Project Settings panel, navigate to the top section where environment tabs are displayed. You will see options for Global, Development environment, QA environment, and Production environment. Click on the relevant environment tab to access its specific settings. Selecting an environment allows you to configure its deployment-related settings, ensuring the appropriate configuration for testing, staging, or live production use.

5. Manage Configuration Settings: After selecting an environment, navigate to the Configuration tab to manage environment-specific settings. You will see a list of existing default configuration settings displayed in a table format.

   • Toggle Visibility:

     • Use the shield icon to toggle the visibility of each setting, making it public or private according to your project's requirements.

     • Click the shield icon to toggle the visibility of a configuration setting:

       • Private values are securely stored in Azure Key Vault, ensuring they remain encrypted and protected.

       • Public values remain visible within the configuration settings panel.

   • Use the Same Value for All Environments: To apply the same value across all environments (Development, QA, and Production), toggle the “Apply globally” capsule-style switch:

     • Enabled: The value is used across all environments.

     • Disabled: You can specify different values for each environment.

   • Delete a settings: To remove a configuration setting:

     • Hover over the setting row – a trash can icon will appear on the right.

     • Click the trash can icon associated with that specific setting.

     • Confirm the deletion when prompted.

Once you've created configuration settings, you can refer to them throughout your application. These settings are stored within the Config service and can be accessed and utilised in various parts of your application's code.

Below is a list of common system-generated configuration variables that you'll typically encounter when working with new projects in the ComUnity Platform's Development deployment environment:

1. AppName: The AppName variable represents the name or title of your application. It serves as an identifier within the ComUnity Platform, helping to distinguish your application from others during the development phase.

2. BaseUrl: The BaseUrl variable specifies the base URL or web address of your application. It defines the starting point for all relative URLs within your application and is essential for proper routing and navigation during development.

3. ComsApi: The ComsApi variable refers to the API endpoint or URL of the communication service within the ComUnity Platform. It enables your application to interact with the communication service, facilitating the exchange of messages, notifications, and other communication-related tasks during development.

4. ComsService: The ComsService variable is a URL that represents the specific communication service employed within the application.

5. ComsServicePassword: The ComsServicePassword variable stores the password or secret key associated with the communication service in the Development environment. It is instrumental in authenticating and securely accessing the service.

6. ComsServiceUsername: The ComsServiceUsername variable stores the username or identifier used for authentication and identification within the communication service during development. It allows your application to connect and interact with the service using the designated user or account within the Development environment.

7. MediaServerUploadUrl: The MediaServerUploadUrl variable denotes the URL or endpoint of the media server responsible for uploading and storing media files within the ComUnity Platform's Development environment. It enables your application to seamlessly upload images, videos, or other media content for use within the platform during development.

8. PublishedAppName: The PublishedAppName variable represents the name of your application as it appears to end users or the public within the Development environment. It is commonly utilised for displaying the application name in user interfaces or when referencing the published version of your application during development.

9. WelcomeMessage: The WelcomeMessage variable contains a pre-defined message or greeting displayed to users when they initially interact with your application in the Development environment. It serves as a friendly introduction or provides essential instructions to guide users through their initial experience during development.

Our deployment process utilises three distinct environments, each colour-coded to prevent deployment errors by providing immediate visual differentiation. This system ensures that modifications and updates are made in the correct environment, safeguarding the development and deployment pipeline.

Development Environment(Green)

This serves as the default playground for developers with relevant access. They can write, test, and refine code freely within this environment before moving it further down the pipeline. This isolated space ensures code integrity and consistency across the team.

QA/Testing Environment(Vibrant Purple)

After the development phase, code is promoted to the QA/Testing environment. Here, rigorous testing takes place to ensure the application functions flawlessly under various conditions. This environment closely resembles the production setup, allowing for the identification and resolution of potential issues before reaching end users.

Production Environment (Deep Purple)

The final stage in the deployment process is the production environment. This is where the fully tested and stable application is made live and accessible to end-users. Deployments to this environment are critical and require meticulous planning and execution to ensure service continuity and reliability.

By employing these colour distinctions—green for Development, vibrant purple for QA/Testing, and deep purple for Production—we enhance operational safety by reducing the risk of cross-environment deployment errors, thereby supporting the overall quality and success of the application.

A project in the ComUnity Developer Toolkit contains everything that defines your namespace for an application.

Take charge of your teams and resources with the Organisations feature in ComUnity Toolkit. This powerful suite streamlines organisational management, empowering you to build productive teams, control access, and ensure smooth collaboration.

Key Features:

• Effortless Organisation Management: Manage organisations with ease and handle administrative tasks efficiently and maintain a clear structure.

• Build Ideal Teams: Add, remove, and group team members intuitively. Assign roles and permissions to ensure the right people are on the right projects.

• Granular Access Control: Define and update permission levels for each team member and resource. Safeguard sensitive information and prevent unauthorised access.

• Secure Collaboration: Control who sees what, setting clear boundaries and promoting a culture of trust and productivity.

Key Features

Streamlined Deployment Workflow:

• Dedicated Environments: Leverage three distinct environments – Development, QA/Testing, and Production – each designed for a specific stage of your project's lifecycle.

• Seamless Transitions: Promote code smoothly between environments, ensuring an efficient development process.

• Enhanced Testing: Conduct thorough testing in the QA/Testing stage, closely mimicking the production environment to identify and address potential issues before launch.

Unparalleled Security and Control:

• Granular Permissions: Define and assign specific roles and permissions to team members, granting access only to the environments and resources they need.

• Safeguarded Code: Restrict unauthorised access to development and testing environments, protecting your codebase from unintended modifications.

• Clear Accountability: Track changes and identify responsible parties easily with role-based access controls.

Overview

Templates are preconfigured application components (entities, associations, navigation, screens, and application objects) that can be added to a project to quickly and easily add specific features. Templates can also be added to a brand new project to fast track creation.

Templates offer a number of benefits, including:

• Speed: Templates can save you a significant amount of time and effort by providing you with pre-built components that you can simply add to your project.

• Quality: Templates are developed by experienced developers and are tested to ensure that they meet high quality standards.

• Flexibility: Templates can be customised to meet your specific needs.

Types of Templates

The platform supports the following types of templates :

• Item templates: These templates add a single feature to a project, such as Governance, Live Chat, or Base Temporal Entity.

• Group templates: These complex templates are used to create fully fledged applications with multiple features, such as Blog, Smart City, or Business Directory. A group template is a set of item templates.

Adding and removing templates in a ComUnity Project

Templates may have dependencies, which are references to other templates. When you add a templates with dependencies to your project, the Toolkit will automatically add its dependencies to the project. Conversely, when you remove a template with dependencies, its dependencies are not removed from your project.

To add a template to a new project

2. After successfully creating your project, you can navigate to Project Settings > Templates to manage templates.

To add a templates to an existing project

1. Go to Project Settings > Templates .

2. All the templates that are already included in your project will have their checkboxes ticked.

3. Select a template by ticking its checkbox. Conversely, you may deselect a template by unticking its checkbox.

4. Click Save.

More details about the templates that are supported in the ComUnity Development Toolkit:

Supported Templates

The ComUnity Development Toolkit includes a variety of supported templates that can be used to quickly and easily add features to your project. Templates are preconfigured application components (entities, associations, navigation, screens, and application objects) that are developed by experienced developers and tested to ensure high quality standards.

Using supported templates can save you a significant amount of time and effort, and can help you to create better quality applications. Templates are also flexible and can be customised to meet your specific needs.

In this subsection, we will list all of the supported templates that are available in the ComUnity Development Toolkit. We will also provide a brief description of each templates and explain how to use it.

We encourage you to browse the list of supported templates and to use them to create your own custom applications. If you have any questions or need assistance, please do not hesitate to contact our support team.

Application Sharing

Base Temporal Entity

The BaseTemporalEntity in the ComUnity Platform is a no-code template for working with temporal tables. It is recommended that temporal entities inherit from the BaseTemporalEntity.

Communities

Economic Development

The Economic Development template provides a comprehensive solution for municipalities to manage economic development efforts in their communities. This template allows businesses to create and manage their listings, while also allowing municipal administrators to send business invitations and other notifications.

With the Economic Development template, municipalities can streamline their economic development efforts and provide a user-friendly platform for businesses to manage their listings and connect with the community. This can help to boost local economic growth and promote a thriving business environment. Contact Us

This template adds application components which allow admins to add contact us numbers and also allows both users and admins to view contact us numbers.

Cases

This template adds application components which allow users to post feedback and also allows admins to view feedback logs. Governance

The Governance template includes application components that enable local governments to publish their documents and procedures for public consumption. Although it was initially designed for municipalities, its generic document publishing capabilities can be adapted to fit other use cases. LiveChat

The Live Chat template provides a generic solution for offering real-time communication with users of digital services, whether it be a website or a mobile application. With the Live Chat feature, users can chat directly with customer service representatives or support agents to get quick answers to their questions, report issues, or provide feedback. NewsFeed The NewFeed template adds application components which allow admins to post and edit news articles and also allows users to view news articles. Notifications

The Terms template adds a page in your application that outlines the terms and conditions of using applications built on the ComUnity Platform, this page is accessible to all of your users. Twitter

The Twitter template allows you to add a Twitter feed to your application using a specified hashtag or Twitter handle. However, currently there is no UI available in the toolkit the configuration of the Twitter feed. You can contact our technical team for assistance in setting up the Twitter feed in your application. Vacancies

The Vacancies template adds application components which allow admins to manage vacancies also allows users to view vacancies and manage their cvs and job applications. Youth Development

The YouthDevelopment template adds application components which allow admins to post and edit youth opportunities and also allows both admins and users to view youth opportunities. Blog

A Blog template is a pre-built template or functionality that can be used to add a blog section to an application or website. It typically includes features such as the ability to create, edit and publish blog articles and manage comments. Business Directory

The Business Directory template provides functionality to add the business profile to your applications, profile properties which can be added include photo, address, geo-location and photo. Smart City

Surveys

The Survey template provides a flexible way to create and conduct surveys within an application. Users can define custom survey questions using a variety of question types, such as multiple choice, rating scales, and open-ended text fields. These questions can be arranged into a survey form that can be filled out by respondents within the application. Once the survey is complete, the responses can be collected and analysed by the application administrators.

When you build your project the ComUnity Developer Toolkit the build service provisions resources for your app on Microsoft Azure and then builds your Data Service project based off your data model definition. If a database exists it then runs a data migration. After a successful build it then publishes your project to Internet Information Services(ISS).

To build your project in the Toolkit go to your project Settings, located under the navigation bar on the right-hand side, you will find the Build & Launch controls displayed below:

• Build Status Indicator: The Build Status Indicator serves as a visual representation of your project's build status. By default, it appears as yellow and changes colour based on the outcome of the build process. After a successful build, it displays a green colour, while a red colour indicates a failed build.

• Build Action Dropdown Menu Button: Clicking on the Build Action Dropdown Menu Button reveals a menu that displays the supported Build Actions. This button allows you to toggle the visibility of the dropdown menu for easy access to these actions.

• Build: The Build action is a critical step in initiating the build process for your project. When you click on the Build action, a modal window will appear on your screen, providing important information about the build progress.

  Within the modal, you will find the following components:

  1. Progress Bar: This visual element allows you to track the progress of your build. It provides a visual representation of how far the build process has advanced.

  2. Completed Steps Counter: This counter displays the number of build steps that have been successfully completed. It helps you keep track of the progress made by the build process.

  3. Launch project when done Checkbox: By selecting or deselecting this checkbox, you can control whether the project will be automatically launched after the build process is complete. Choose according to your requirements.

  4. Hide Window: If you wish to dismiss the modal window, simply click on the "Hide Window" button. This action will close the modal and allow you to continue monitoring the build progress and outcome.

  To view the progress and outcome of your build, navigate to the top of your project Settings page, just below the navigation bar, where the Build controls are displayed. Here, you can observe the ongoing build progress and the outcome of the most recent build. This section provides you with a convenient overview without the need to keep the modal window open.

  By utilising these features, you can effectively manage and monitor the build process of your project within the ComUnity Toolkit.

It's important to note that errors can occur during the build process. If an error occurs, the build outcome indicator will display a red colour to indicate a failed build. In such cases, you may need to review the error messages or logs to identify and resolve the issues that caused the build failure.

• Build & Launch: The Build & Launch action combines the build process with the automatic opening of the web version in a new browser tab. By selecting this action, your project will be built, and the web version will be launched automatically. Please ensure that browser popups are enabled for your launch to work. This build action is selected by default, providing a streamlined approach to building and launching your project.

• Launch: The Launch action allows you to directly open the web version of your project in a new browser tab. By choosing this action, you can quickly access and view your project without going through the build process. This option is ideal if you have previously built your project and want to launch it again without any modifications.

Organisational Management within the Toolkit is a comprehensive feature designed to empower the Organisation Administrator with the tools and capabilities necessary for effective management and oversight of their organisation. This functionality is pivotal in maintaining a structured, efficient, and collaborative environment within the platform.

Responsibility and Prerequisites

The Organisation Administrator is the key individual responsible for managing their organisation within the Toolkit. They are the first point of contact and register the organisation on the platform.

Key Responsibilities

• Managing Users: Granting access, assigning roles, and maintaining user accounts within the organisation.

• Creating and Managing Teams: Establishing teams, assigning members, and managing their composition.

• Project Management: Overseeing projects, assigning project owners (leaders), and ensuring efficient project execution.

• Organisational Control: Having full visibility into all projects, reassigning project ownership as needed, and modifying team structures to optimise collaboration.

In essence, the Organisation Administrator holds the highest level of authority within the Toolkit, granting them comprehensive control over their organisation's functionality.

Manage Your Organisation

View and Edit Organisation Details

To access and modify your organisation's details, follow these steps:

1. Log In: Sign into the Toolkit with your credentials.

2. Access Organisation Settings: From the main menu, navigate to "Organisation Settings".\
3. View and Edit Details: Here, you can view your organisation's information and edit details such as the organisation's name.

Manage Users and Roles

To manage users and their roles within the organisation, proceed as follows:

1. Access Organisational Settings: Go to the "Organisation users and roles" tab within the Organisational Settings.
2. View Users: This section displays all users associated with your organisation. Use the search functionality to find specific users and the view functionality to find users by role.
3. Modify User Access: To remove a user from the organisation, click the three-dot button next to the user's name and confirm the action in the "Delete Member" modal.
5. Assign/Remove Roles: Click the plus icon in the Roles assigned to the user, an "Assign or remove team member roles" modal will appear**.** In the "Assign or remove team member roles" modal, check or uncheck roles to assign or remove them, respectively.
6. Apply Changes: Click "Apply" to save your modifications.

Supported User Roles and Permissions

This section outlines the default user roles supported in the Toolkit. The roles manage access to various components and functionalities within the system. Permissions are environment-specific, and access rights range from 1 to 3.

Default Roles

• Lead Developer

• Developer

• Operations

• Viewer

Each role has specific permissions across the development (DEV), quality assurance (QA), and production (PROD) environments.

Access Rights Legend

• 1: View only

• 3: Full access (view and edit)

Lead Developer

Developer

Operations

Viewer

Access Rights Legend

• 1: View only

• 3: Full access (view and edit)

Teams

Conclusion

By following these guidelines, the Organisation Administrator can effectively manage the organisation's structure and member roles within the Toolkit, ensuring a streamlined and efficient operational environment.

The deployment process within the ComUnity Platform is a critical pathway that ensures your application is thoroughly tested and stable before it reaches the end-user. Adhering to a structured and sequential progression through the Development, QA/Testing, and Production environments, each stage serves as a gatekeeper, ensuring only the highest quality code is promoted.

Deployment Types: Partial vs. Full Deployment

When deploying your project within the ComUnity Platform, it is essential to determine whether a partial or full deployment is necessary. Each type of deployment serves different purposes and is used under specific conditions.

Full Deployment

A full deployment involves deploying all components of your application. This includes the Data Service, Authorisation Service, Client, Communication service, Configuration, Screens, and any other modules or services within the application. Full deployments ensure that all parts of the application are updated and synchronised.

Use cases for Full Deployment:

• Initial release of the application.

• Major updates or changes that impact multiple modules or components.

• Structural changes to the application that require all components to be redeployed.

Components in a Full Deployment:

• Data Service

• Authorisation Service

• Client

• Communication Service

• Configuration

• Screens

• All other application modules and services

Partial Deployment

A partial deployment involves deploying only specific parts of the application. This type of deployment is useful when minor updates or bug fixes need to be applied without redeploying the entire application. Partial deployments save time and resources by targeting only the affected components.

Use cases for Partial Deployment:

• Minor bug fixes or updates that affect only a specific module.

• Incremental updates that do not require a full application redeployment.

• Changes to configuration files or settings that do not impact the overall application structure.

Examples of Partial Deployments:

• Authorisation Service: Deploy updates or fixes to the authorisation without affecting other parts of the application.

• Client: Coming soon..

• Communication Service: Update communication configurations or client modules independently.

• Configuration: Modify and deploy changes to specific configuration

• Screens: Modify and deploy changes to specific screens or UI components.

Determining the Deployment Type

During the deployment process, the ComUnity Platform allows you to select the deployment type based on your needs. For a full deployment, activate the Full Deployment toggle and ensure all components are selected. For a partial deployment, deactivate the Full Deployment toggle and select only the necessary components.

The decision between partial and full deployment should be based on the scope and impact of the changes being made. By selecting the appropriate deployment type, you can ensure a smooth and efficient deployment process, minimizing downtime and maximizing application stability.

Prerequisites for Deployment

1. Successful Build: Before initiating deployment, confirm that your project has successfully built without any errors or critical warnings.

Prepare the Project Archive for Deployment

To prepare your project archive for deployment, follow these carefully outlined steps to ensure your application is packaged correctly and ready for the deployment process.

1. Download the Project Archive:

   • Obtain the latest version of your project archive. This will include all the necessary files for deployment.\
2. Open the Web.config File:
3. Update Configuration Settings:

   • Within the Web.config file, remove keys 13-19 under <appSettings> that are pertinent only to local development.

   • Modify the ConfigDeployment key to reflect the deployment environment, for example: value="<app_name>_qa" for QA deployments and value="<app_name>_prod" for Production deployments. The updated section should resemble the following:

     Go to Project Settings > General and then locate Application Name to view your <app_name>. Refer to the General section for more details.

     It is crucial to adhere to the naming convention for the ConfigDeployment key to accurately reflect the deployment environment (e.g., <app_name>_qa for QA and <app_name>_prod for Production) to otherwise failure to do so will result in deployment errors

4. Save and Build:

• Save the changes made in the `Web.config` file. *

• Build your project within Visual Studio to confirm that there are no compilation errors or issues with your code.

6. Compress the Package: Compress the deployment package into a .zip file format, readying it for the deployment process.

By the end of these steps, you should have a properly configured and compressed project archive that is ready to be deployed to the designated environment.

Deploy Your Web Deployment Package: A Step-by-Step Guide

To successfully deploy a project, follow these steps:

Note: To progress through each step, ensure all required fields and assets are properly set, then click the "Next" button to proceed.

1. Set Deployment Name and Release Notes: Begin by naming your deployment and providing detailed release notes that outline the changes and features included in this deployment. \
2. Click the "Create assets" button to proceed with a full deployment

3. To perform a Partial Deployment:

   1. Deactivate the Full Deployment Switch: Ensure the Full Deployment toggle is deactivated.

   2. Select Relevant Components: Choose only the necessary components (e.g., Authorization, Communication, Configuration) to deploy.

   3. Create Assets: Click the "Create assets" button to proceed.

5. Review Your Configuration Scripts: Thoroughly review the configuration scripts to ensure they are correct and will execute as expected without errors. Make any necessary adjustments. \
6. Deploy: With all configurations and reviews complete, proceed to deploy your project. This final step may take some time, so please be patient.\

In conclusion, following this structured and detailed guide ensures that your project is deployed smoothly and effectively. By methodically setting up, reviewing, and executing each step, you minimise the risk of deployment errors and ensure your application performs optimally in its intended environment. This careful attention to the deployment process not only smooths the transition between environments but also supports the ongoing development and scalability of your application.

Once you have successfully logged in, you will be directed to the Home screen. If you are already actively engaged in a project, click on the Home navigation item located within the menu bar.

To create a new project, follow these steps:

1. Go to the Start a new project section at the bottom of your home page. Here, you'll find a variety of templates to choose from to help you create your project.

3. Once you've found a suitable template, click on the Use This button on the template's card. This will open a new dialog box where you can enter your project details.
4. Enter a unique name for your project in the Project name box.

5. Click on the Create button to create your new project

6. Once your project is successfully created, click on Settings to access your project's settings.

Overview

In the dynamic environment of the Toolkit, roles and permissions are foundational elements that ensure secure, efficient, and effective management of projects and teams within an organization. Understanding the distinct roles within the Toolkit and the permissions associated with each is crucial for users to navigate and utilise the system to its full potential.

Roles within the Toolkit are designed to cater to various levels of responsibility, from system-wide oversight to specific project tasks. These roles facilitate a structured approach to project management, allowing for clear delineation of duties and access control. Permissions linked to these roles define what actions a user can perform, ensuring that sensitive operations and information are accessible only to authorised individuals.

This section of the documentation aims to provide a comprehensive overview of the roles available within the Toolkit, detailing the permissions each role holds and the significance of these roles in the overall management of projects and organisational settings. Whether you are a Toolkit Administrator managing the system at a global level, an Organisational Administrator overseeing projects and teams, or a Developer contributing to project tasks, understanding your role and permissions is the first step towards maximising your effectiveness and contribution within the Toolkit.

By the end of this section, you will have a clear understanding of how roles and permissions work in tandem to support a secure, organised, and collaborative environment for all users involved in project and team management.

Supported Roles

In modern project management, clear roles and responsibilities are essential for operational efficiency and success. The Toolkit is designed to support organisations with a well-defined role hierarchy, ensuring smooth project development from strategic oversight to detailed task execution.

The Toolkit framework assigns specific permissions and responsibilities to each team member, from Organisational Administrators to Developers and Designers. This structure fosters effective collaboration and access control, ensuring everyone contributes to the organisation's goals. By outlining this role hierarchy, we highlight the importance of organised collaboration and access control within the platform.

Understanding your role within this structure is the first step toward leveraging the Toolkit's full potential and driving your organisation's success. Whether you're managing the organisation or contributing your expertise, the Toolkit's framework helps maintain order and efficiency in collaborative projects.

1. Toolkit Administrator

   • Positioned at the highest level, the Toolkit Administrator has system-wide access and control over all organisations, projects, and users within the Toolkit. This role is responsible for the overall management and configuration of the Toolkit, including user and organisation approvals.

2. Organisational Administrator

   • Positioned at the top of the organisational hierarchy is the Organisational Administrator, who has full control over all aspects of their organisation within the Toolkit. This includes managing users, creating teams and assigning team members, managing projects, assigning project owners, and overseeing the assignment of various teams and roles within the organisation. The Organisational Administrator can view all projects, reassign project ownership, and edit team compositions.

3. Project Owner

   • The Project Owner has control over a specific project, including visibility and editing rights. Initially, they are the sole individual with access to the project until they assign teams to it. The Project Owner can manage the project details, progress, and team assignments but operates under the governance of the Organisational Administrator.

4. Teams (Developers, Lead Developers, Testers, DevOps etc.)

   • Teams consist of individuals with roles such as Developer, Lead Developer, and other specialised roles defined within the organisation. These roles have specific permissions related to project development, such as editing project files, contributing to development tasks, and collaborating with other team members. The composition and assignment of these teams are managed by Project Administrators and overseen by Project Owners and the Organisational Administrator.

5. Individual Contributors (Developers, Designers, Testers, DevOps etc.)

   • At the project level, individual contributors work within their teams on specific tasks and projects. They have access and editing rights to projects they are assigned to and follow the directions of their team leaders (e.g., Lead Developers) and project governance established by Project Owners and Administrators.

User Role Journey

This section outlines the user role journey from initial signup:

1. Initial Signup: A new user signs up to the Toolkit, representing a company or an individual with the intent to partner and build applications within the platform.

2. Initial Role Assignment: Upon signup, if the user is the first or only member of their organisation within the Toolkit, they are most likely to be made an Organisational Administrator. This role grants them the ability to manage the organisation's presence within the Toolkit, including project and user management.

3. Role Expansion: As the platform evolves, the plan is for Organisational Administrators to be able to invite new users into the organisation. These new users would immediately have access to the Toolkit, and their roles within the organisation can be set by the Organisational Administrator. This functionality aims to streamline the onboarding process for new users and facilitate role assignment within the organisation.

4. Manual Role Assignment (Current State): Currently, if another member of the organisation needs access to the Toolkit, they must register independently. The Toolkit Administrator then manually assigns this new user to the organisation, after which the Organisational Administrator can set their roles, such as Developer, Lead Developer, Tester , DevOps or any other defined role within the system.

5. Toolkit Administrator Role: The Toolkit Administrator plays a crucial role in this process, as they are responsible for approving registrations, creating organisations, and assigning users to organisations. This role is essential for the initial setup and ongoing management of user roles and organisation structures within the Toolkit.

Supported Roles and Permissions

Lead Developer

Developer

Operations

Viewer

Access Rights Legend

• 1: View only

• 3: Full access (view and edit)

This format organizes the roles and their permissions in a clear tabular manner, making it easier to understand which components each role has access to and in which environments.

Developers using the ComUnity Developer Toolkit have the flexibility to build their application data models either as a Diagram (Entity Relationship Diagram - ERD) or as a List, each offering unique benefits.

When visualising the data model as a Diagram (ERD), developers gain a clear and intuitive representation of the data entities and their relationships. This visual approach simplifies the process of specifying entity properties, defining relationships, and establishing data constraints. Diagrams (ERDs) aid in designing an effective database schema, allowing developers to easily identify and optimise the structure and connections between entities.

On the other hand, representing the data model as a List provides a concise and organised view of the entities and their properties. This approach offers a straightforward way to define the structure of the data without the need for a visual diagram. Developers can easily specify entity properties, data types, and relationships using the List format, making it a suitable option for simpler data models or cases where a visual representation may not be necessary.

Both approaches have their advantages. The Diagram (ERD) provides a visual representation that aids in understanding and optimising complex data relationships, while the List format offers a streamlined view for simpler data structures or when a visual diagram is not required.

Managing Teams

Responsibility and Prerequisites:

The task of assigning managing teams to a project is entrusted to the Organisational Administrator.

To manage teams in the organisation, proceed as follows:

1. Login to the ComUnity Developer Toolkit

2. Access Organisation Settings: From the main menu, navigate to "Organisation Settings".
3. Access Teams: Go to the "Teams" tab within the Organisational Settings.
4. View Teams: This section displays all teams in your organisation.

5. Create a Team:

   • To establish a new team, click the "+ Create Team" button.

   • In the "Create Team" modal that appears, enter the team's name and confirm the creation.

6. View Team Members:

   • For details on a specific team, click the "View Team" button adjacent to the team's name.

   • A detailed view of the team members along with their roles will be displayed. Utilise the search function for an enhanced experience in finding specific members or roles.

7. Delete a Team: To delete a team, click the three-dot button next to the team's name and confirm the action in the "Delete Team" modal.

Assign Teams to a Project

Responsibility and Prerequisites

The task of assigning teams to a project is entrusted to the Project Owner. Before proceeding, ensure that the necessary teams have already been established within your organisation. This step requires collaboration with the Organisational Administrator, who is responsible for creating teams and assigning members to those teams.

Assigning Teams to a Project

In the Toolkit, the flexibility of project management is enhanced by allowing Project Owners to assign teams not only after a project has been established but also directly during the project creation phase. This capability streamlines the setup process, ensuring that the right resources and teams are aligned from the outset.

Assigning Teams During Project Creation

1. Initiate Project Creation: When creating a new project within the Toolkit, fill out the project details as prompted.
2. Team Assignment Option: Look for the "Assign one or more teams to the project" section within the project creation interface. This step occurs before finalising the project setup.

3. Select Teams: Choose from the list of available teams within your organisation. If the required team is not listed, remember that the Organisational Administrator can create and configure new teams.

4. Finalise Project Creation: After selecting the desired teams, proceed to complete the remaining project details and finalise the creation process.