Meta Declaration

The document explains metadata of a view-plugin that shows the application data for the customers subscribed to the application services.

Refer to the Announcement document that explains how to advertise the application service to the other customers.

Navigation

The Home dashboard is built by a system APS application that exposes the http://www.parallels.com/ccp-dashboard#dashboard place-holders to embed view-plugins of other APS applications.

To plug its view-plugin into the Home dashboard, an application must declare it in a navigation tree. This view-plugin can be in a separate navigation tree, or you can add it to an existing navigation tree. In the following example, an application plugs the vpsDashboardPlugin view-plugin into the Home dashboard.

<navigation id="plugins">
   <view-plugin id="vpsDashboardPlugin" src="ui/plugins/vpsDashboardPlugin.js">
      <plugs-to id="http://www.parallels.com/ccp-dashboard#dashboard"/>
   </view-plugin>
</navigation>

Note

1. Store the view-plugin JavaScript source in the ui/plugins/ folder.
2. The plugs-to element must be defined directly in the view-plugin element.

When using the basic method, specify the service whose properties the custom tile will show. For this, you need to define a navigation variable for the APS type bound with that service.

Note

The APS type specified by the variable must implement the standard SubscriptionService APS type.

The previous example can be modified as follows:

<navigation id="plugins">
   <view-plugin id="vpsDashboardPlugin" src="ui/plugins/vpsDashboardPlugin.js">
      <plugs-to id="http://www.parallels.com/ccp-dashboard#dashboard"/>
      <var name="context" type-id="http://aps-standard.org/samples/basic1pdash/context/1.0"/>
   </view-plugin>
</navigation>

Custom Style

The <presentation> section of the service specified by the navigation variable or by the apsType property of the view-plugin allows you to define the following style properties of a tile in the Home dashboard.

PROPERTY	EXAMPLE	DESCRIPTION
name	<name>VPS Management</name>	A string that defines the title.
summary	<summary>Virtual servers, their states, and resource usage</summary>	Explanation of the data presented in the tile.
icon	<icon path=”images/icon.png”/>	Path to an icon displayed on the bottom-right corner of the tile.
color	<color>#34495E</color>	Background color in RGB format.
font-color	<font-color>#34495E</font-color>	Font color in RGB format.

Note

1. The definition of the following presentation elements must comply with this specific order: icon -> color -> font-color.

2. The <color></color> and <font-color></font-color> pairs must contain a hex value without spaces.

Continue Your Demo

This section continues the demo project started in the previous step.

Declare View-Plugin

Declare the navigation tree plugged into UX1 for customers with a single view-plugin. The view-plugin must plug itself into the Home dashboard. Add a variable referring to the APS type implementing the subscription service.

Once you have done it, the navigation section must look as follows:

<navigation id="plugins">
  <view-plugin id="vpsDashboardPlugin" src="ui/plugins/vpsDashboardPlugin.js">
    <plugs-to id="http://www.parallels.com/ccp-dashboard#dashboard"/>
    <var name="context" type-id="http://aps-standard.org/samples/basic1pdash/context/1.0"/>
  </view-plugin>
</navigation>

Define Tile Style

Require a custom visualization style by means of style properties in the presentation section of the contexts service, as in the following example:

<service id="contexts">
  <code engine="php" path="scripts/contexts.php"/>
  <presentation>
     <name>VPS Management</name>
     <summary>VPS management environment</summary>
     <icon path="images/icon.png"/>
     <color>#34495E</color>
     <font-color>#FFFFFF</font-color>
  </presentation>
</service>

Note

Do not use spaces in the color and font-color definitions.

Conclusion

This completes development of the metadata. You can find the similar APP-META.xml file in the sample package.

← Home Dashboard

Presentation Logic →