Allegro
Note: This content is currently in progress and not yet complete.
Overview
Allegro UI is designed using the Aria CCP UI libraries and framework. Please note that the base for the library was what was provided and used in March 2025. Since then, CCP UI has evolved with introduction of more color schemes and UI visualizations. As a result, you might see some subtle differences. We intend to bridge that gap before or around the Release 67 deployment to production.
Accessing Allegro UI
This functionality is under development. The intent is that it will re-use the same framework that is currently used with CCP UI using the Key Cloak service that acts as an interface for oAuth2 authentication for the user or manage the SSO with an Identity manager service. There are two possibilities:
- User is already logged in and has an active session with CCP UI or Admin UI and the user uses the link from the Admin UI or CCP UI to access Allegro UI. In this example, the user has an active session, and the Aria Allegro UI will not require re-login and will be provided with access to the Allegro UI
- User session ends or the user logs in fresh with Allegro UI, the user will be provided with the same login screen as with Aria Admin UI and Aria CCP UI and a successful login would provide access to the Allegro UI.
How does Aria Allegro control the access levels for the users
Allegro platform avoids re-inventing the entire User Management and creation of specific roles for Allegro UI. It manages the existing Aria framework to provide access to Allegro. All of this is seamless and behind the scenes covers the following:
- A table of all Allegro permissions. This will continue to be managed with each release as more capabilities are added to the Allegro platform.
- A Static configuration that provides the mapping of the permissions that are allowed in Aria Admin UI (subset that needs to be mapped) and the Allegro permissions.
- Admin users will create roles in the Aria Admin UI as it is done today.
- New users will be added using the same existing framework in Aria Admin UI.
- For users trying to start a fresh new session, Allegro UI will guide them to the same login screen as used by the Aria Admin UI or the SSO login with the Identity manager setup for the deployment.
- For existing users, the existing services will provide a token for the active session and that will be used with Allegro UI to grant access including the session timeout parameter.
- Core Aria APIs at play with Allegro platform for access management,
- getCurrentUser—Allegro UI calls Allegro core API which in turn calls the core Aria API to get the current user.
- getUiAccountPrivileges—Allegro UI calls Allegro core API which in turn calls the core Aria API to get the current privileges for the user, overlay that with the mapping provided in point-2 and manage access according to the map data returned.
- getUiProductCatalogPrivileges—Allegro UI calls Allegro core API which in turn calls the core Aria API to get the current privileges for the user for product catalog, overlay that with the mapping provided in point-2 and manage access according to the map data returned.
- The UI will get the session timeout value and manage the session accordingly.
In the future, if required, a broader framework can be added which allows the following:
- Creation of Roles for Allegro permissions
- Creation of Role Groups to add different Roles into a Role Group
- Adding users into the platform
- Assigning Roles or Role Groups to a user.
- Creation of user groups with existing users.
- Managing multi-level approval with user groups for any functionality as required. For example, managing multi-level approval framework for Adjustments/Credit Memos based on reason code.
User Guide
- Allegro UI General Layout
- This section presents an overview of the various components of the Aria Allegro UI.
- Navigation Pane or Main Menu
- Activity Pane
- Client Selection
- Header Links
- Multiple Tabs
- Usage—Account Switch
- Home Page
- Drawer vs. Expand Activity Pane
- CCP Search vs. Multi-Attribute Search
- Pagination with Multi-Attribute Search
- Cozy vs. Compact View
- Minimize Navigation Pane
- Changing to a Full Screen View
- Selecting Columns in the Activity Pane
- Allegro UI Components
- This section covers various types of UI components.
- Aria Allegro and Aria Core
- This section covers some of the commonalities and in brief explains a typical process to set the two systems to enable a functioning Client production environment or an environment for Sales and Professional Services demos.
- Allegro Configurations
- This section presents the various configurable components of Aria Allegro.
- Allegro Price Plans
- This section covers the user guide for Allegro monetization models and Price plans associated with the monetization models.
- Allegro Mediation Setup
- This section covers the Mediation setup required for usage processing with Allegro. Mediation refers to a phase in usage processing that covers the ingestion of the usage records before it runs through the engine for rating/discounting needs.
- Usage Processing Setup
- This section covers the configuration of the usage processing engine for rating. The Allegro usage processing engine currently handles rating and will soon support discounting, revenue sharing, and commissions calculations.
- Jobs Schedule Management
- Jobs Management enables users to configure one or more independent job schedules per client. This functionality allows users to: Configure multiple job schedules for a client Execute job schedules manually or automatically
- Usage Operations
- This section details the usage activity any operator may need to view, review, or reprocess. Similar activities apply to test/demo setups.
- Aria Sync Re-processing
- This section details the information the usage operator needs to view, review, and reprocess synchronization records, errors, and their reprocessing between core Aria and Aria Allegro.