Application Packaging Standard

Last updated 18-Mar-2019

User Management

This document explains how an APS application integrates with the User Management system application to allow customers to assign services to users and manage those services. The APS Biz API will help us on this way.

The embedded demo project logically continues the Offer Management demo project.

../../../_images/tracks-users.png

Benefits of the integration for customers:

  • Assign application services to users when adding users to a customer account.
  • View necessary resource usage statistics in the list of users.
  • Manage application resources from a user profile personally for the selected user.
../../../_images/user-step-model-b.png ../../../_images/user-step-meta.png ../../../_images/user-step-provision.png ../../../_images/user-step-presentation.png ../../../_images/user-step-deploy.png ../../../_images/user-step-provisioning.png

UI Scenarios

On completion of this project, you will get a demo application with the following features:

  • When creating users, a subscriber will be able to add a VPS (virtual private server) to the users basing on service profile (offer) available in the subscription.

    ../../../_images/add-user-step1.png
  • In the list of users, a subscriber will see application resource usage and statuses per user.

    ../../../_images/user-list-tiles.png
  • In a user profile, a subscriber can add or remove VPSes as well as get more details about resources.

    ../../../_images/user-pers.png
  • Service users can log in to the user control panel to view and manage resources assigned to them.

    ../../../_images/mycp-servers.png

Resource Model

To reach the goals, the application must implement at least the following resources in its resource model:

../../../_images/user1p-resource-model.png
  • cloud - the application root resource
  • context - the customer VPS management environment
  • vps - represents a VPS
  • offer - represents an offer (service profile)

Compared with its predecessor, the new resource model requires each VPS to have a link with a user whom the VPS is assigned.

Note

A link to a user is required for integrating the application with the User Management system.

Start Your Demo Project

Clone the package you have created in the Offer Management demo project to the new one by following these steps.

  1. Create a new project based on the input package and using one of the ways:

    • In the Eclipse or IntelliJ IDEA IDE, import the package and then rename it, for example, assign it the suwizard1p name.
    • Extract the package to a folder, for example, to suwizard1p/.
  2. Replace every occurrence of custom application ID and type ID prefix with “http://aps-standard.org/samples/suwizard1p/” in all project files. This will replace the old application and types with the new ones.

  3. To verify if there are no typo in the new project, try to build the new package using either Eclipse IDE, IDEA IDE, or command line APS tools. For example, run:

    $ aps build suwizard1p
    

If no errors detected and you have successfully built an APS package, then proceed to the next step.

Conclusion

In this first step, we identified the purpose of the application, a relevant scenario, and a resource model.

To reach the goal, you have started the demo project to create and test an APS package similar to the sample package.