Application Packaging Standard

Last updated 18-Mar-2019

Integration Points¶

The Integration Procedures guide introduces the Integration Points exposed by the platform to allow APS applications to use the platform services. Here, we consider only a part of that list related with UX.

In this document:

Terms Definition
Main Navigation Tree
Home Dashboard
Documentation

Terms Definition ¶

View Types¶

In the APS JS SDK, a view is a separate JS module defined in a separate JS file and declared in the application APP-META.xml file. A view contains the definition of all widgets to be available on the current main screen of the user panel and the actions on various events. In UX1, there are several view types:

View - an ordinary view based on the aps/View module that can be plugged into the application navigation tree or into a wizard.
Wizard - a special view based on the aps/View module that exposes a placeholder to allow ordinary views to plug into it. A wizard calls the plugged views in a chain, collects the supplied requests and then activates the processing of those requests.
View-Plugin - a special module based on the aps/nav/ViewPlugin module that can plug into a user panel view, for example, into the Home dashboard.
Pop-up View - an interaction view based on the aps/PopupView module and used to capture a user’s attention for an immediate action.

Platform Built-in Integration Points¶

From the UX standpoint, the integration points are split into the following groups.

Common integration points - typically used by any APS application to plug themselves into:
- Main Navigation Tree
- Home Dashboard
User Service - used by APS applications that are providing their service on the per-user basis as compared with a per-account service
DNS Service - used by APS applications whose service requires a bound domain service
Subscriptions - allows APS applications to plug their shortcut in the screen presenting subscription details (subscription profile) as well as to present some subscription data (for example, resource usage) in a custom view.

Main Navigation Tree ¶

Every application needs to show at least its landing page in UX1 to allow customer administrators to manage the application main service. This page is often called “main service view”. Along with it, an application usually has other views, bound to each other in a navigation tree structure with the main service view on top of it. The application plugs its navigation tree into the UX1 left-hand side menu to make it visible along with the platform services, such as user service and domain service.

../../../../../_images/ccp-navigation-top.png

Optionally, the main service view can be placed at the second level of the navigation tree along with other views.

../../../../../_images/ccp-navigation-level2.png

Home Dashboard ¶

The platform provides the UX1 home dashboard as a place to create application shortcuts for quick access to their main views. A shortcut is a tile that shows some service data and contains one or more links to application views.

The application can transfer its shortcut for a customer in dependence of the customer’s relationship with the application service as follows.

The customer did not subscribe yet to the service supplied by an application. In this case the application announces its service for the customer:
The customer has acquired a trial subscription with the application services and then notices a way to switch the trial subscription period to a paid subscription period:
The customer uses a full-featured application service: