Profile on RIA Docs

Applications

Mon, 01 Jan 0001 00:00:00 +0000

Overview

An application is a microservice that makes a Product.

Every application can have a group of supported endpoints and fields. They form the basis for the following privilege-based access controls:

Services — manages API endpoints utilized by the applications.
Fields — manages form controls on the user interface of a product.
Menu items — manages menu options displayed in the left navigation of a product.

It is essential to ensure that each microservice or application is well-designed, maintained, and tested to ensure that it functions flawlessly with the other components of the product.

Organizations

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The Organization represents the legal entity in the Ocular framework.

The Organization module allows you to configure your SMTP to facilitate email notifications. Additionally, you can also configure authentication mechanisms, such as basic authentication and OAuth 2.0.

You can add multiple users to your organization. To learn more about users, see Users.

Create an organization

To create an organization, click Create New and enter valid values in the following fields:

Privilege codes

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Privilege Codes provide detailed control over access to application resources, services, and individual fields.

These codes serve as a centralized permission layer and can be applied at various levels:

Application-Level — Control access to REST endpoints and operations such as create, read, update, and delete.
Service-Level — Control access to internal framework services and capabilities.
Field-Level — Control visibility and behavior of fields in API requests/responses or UI forms.

Privilege Codes are both configurable and extensible. The framework comes with a set of commonly used privilege codes out of the box, and developers can create additional custom privilege codes based on the specific needs of their applications.

Products

Mon, 01 Jan 0001 00:00:00 +0000

Overview

A product is a collection of multiple interconnected microservices or Applications that work together to provide an integrated business solution.

Create a product

To create a product, click Create New and enter valid values in the following fields:

Field

Description

Product Code

Code of the product.

Mandatory: Yes

Product Name

Name of the product.

Mandatory: Yes

Landing Page

URL of the first page the user will see when the application is loaded.

Mandatory: Yes

Role groups

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The Role Groups module allows you to create groups of multiple Roles that can be easily assigned to Organizations. This simplifies the role assignment process, allowing organizations to manage the roles effectively and ensure that the correct privileges are assigned to the appropriate individuals.

Create a role group

To create a role group, click Create New and enter valid values in the following fields:

Field	Description
Role Group Code	Code of the role group. Mandatory: Yes
Role Group Name	Name of the role group. Mandatory: Yes
Organization	Organization for which the role group will be applicable. To view the details of the selected products, click the go to icon. (similar behavior with product). For more information about organization, see Organizations. Mandatory: No
Roles	Roles to be included in the role group. Only the roles associated with the selected organization will be displayed in the dropdown list. Multiple roles can be selected for a role group. For more information about roles, see Roles. Mandatory: Yes
Description	Additional details of the role group. Mandatory: No

Views

Card View

The card view presents all role groups in the form of cards, with the role group code on the card header. The card displays the Role Group name and Description. The card footer displays the number of roles in the role group, a duplicate icon, and a delete icon.

Roles

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The Roles module allows you to configure privileges or permissions at the following levels:

Application privileges
User privileges
Low-level security and access control

Create a role

To create a role, click Create New and enter valid values in the following fields:

Field

Description

Name

Name of the role.

Mandatory: Yes

Role Code

Code of the role.

Mandatory: Yes

Role Type

Type of the role. The following are the possible values:

Users

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Users represent the users of the Products configured for your Organization. The following are the various types of users that identify the level of access across the product suite:

User Type	Organization	Access
Framework Admin	Products owners	Full access to framework modules and services No access to products purchased by clients
Business Admin	Client organization	Limited access to framework modules and services Limited access to purchased products based on assigned roles and privileges
Business User	Client organization	No access to framework modules and services Limited access to purchased products based on assigned roles and privileges

Create a user

To create a user, click Create New and enter valid values in the following fields: