Previous topic

Integration with Provider Control Panel

Next topic

Integration with Service User Control Panel

Last updated 17-Jul-2017

Integration with Customer Control Panel

Embedding to CCP

One of placeholders predefined in the APS specification allows embedding a navigation tree into the Odin Service Automation customer CP as a tab in the top level menu. In the following example, metadata declaration in APP-META.xml makes the tree with the “VPS Management” label embedded into the customer CP, as required by element <plugs-to id=””/>.

<navigation id="ccp" label="VPS Management">
    <var name="context" type-id=""/>
    <plugs-to id=""/>
    <item id="servers" label="Servers">
        <view id="servers" label="Servers">
        <view id="server.edit" label="Edit">
            <var name="vps" type-id=""/>
    <item id="counters" label="Resource Usage">
        <view id="counters" label="Resource Usage"/>
    <item id="events" label="Event Notifications">
        <view id="events" label="Event Notification Log">
            <var name="events" type-id=""/>


Navigation hierarchy must look as item-item-view. The top level item defines an embedded custom menu, and the items below it are menu items.

In the customer CP, it looks as presented below.


APS UI in this case allows the customer to create and manage purchased resources of the application, such as VPSes in our example. Odin Service Automation customer CP supports breadcrumbs when navigating in the APS UI tree.

Auto-generated Widget


In the Odin Service Automation customer control panel, each APS application that is provisioned in a subscription and has entry-points defined in APP-META.xml is represented by its auto-generated widget on the Home page, when this subscription is selected.


The widget contains the following components defined in the <presentation> section of the package:

  • Summary - used as the widget title
  • Description - text output
  • Icon
  • Available entry points

Entry-points of the application services are placed on the bottom of the widget. They are presented in the form of clickable direct links to various views of the custom UI navigation panel.


If the package does not have any entry points defined, the widget will not be shown on the Home page.


All three application presentation elements (summary, desription, and icon) are mandatory for certified packages. In the APP-META.xml file, they look as in the following example:

   <summary>Simplest counter management multi-tenant application</summary>
   <description>This is a demo application to demonstrate
      how to develop APS application step by step.
   <icon path="images/icon.png"/>

A service entry-point is configured in the service presentation section and consists of the following elements and attributes:

  • The <entry> element contains the dst and class attributes.
    • The dst attribute refers to the custom view that must open when a user clicks the link. Its value consists of the application ID and the view ID separated by the “#” symbol.
    • The class attribute must be “aps2-view”.
  • The <label> element defines the text of the link displayed by the widget.

For example, the following entry-point will be displayed as VPS Management link to the servers view of the application whose ID is

<service id="vpses">
         <entry dst=""
            <label>VPS Management</label>