Direct Links

UX1 allows application users to access any navigation item or view of an application UI through a direct link that is unique for each view. It is possible to create direct links to almost any screen such as:

• Informational page

• Login form

• Any application UI view or navigation item

• Solution of a problem raised in application UI

Concepts

Usage of direct links is based on the following principles.

• When a view is open in a browser, you can copy the URL from the address box and then use it as the direct link to the view as in the following examples:

  • Send to anybody including support team

  • Save it as a bookmark

  • Use it in an application code

• There are some rules considered in this document that help you figure out the direct link to a view to arrange dynamic navigation.

• A direct link can also specify resources that must be processed by the addressed view.

For example, when you open the UX1 dashboard (Home), in the browser address box you will find the direct link to it.

Anyone who has access to this UX1, can paste the https://b.isv1.aps.demo.org/ccp/v/pa/ccp-dashboard/dashboard URL to their browser address box to switch directly to the UX1 dashboard.

Link Structure

Links to Navigation Elements

You can create a direct link to a navigation item or a view and specify a list of resources and a list of parameters. Inside an application UI script, the structure of a direct link looks as follows.

/[v,i]/<application id without CCP prefix>/<view id>/r/<resource1 from navigation context>/
      <resource2 from navigation context etc>?<parameter1 name>=<parameter1 value>&
      <parameter2 name>=<parameter2 value>

In this structure:

• /v/ or /i/ denotes view or item

• /r/ is the resource delimiter in the list of resources

When testing direct links in a browser, add the proper CCP prefix in the address box, for example, https://b.isv1.aps.demo.org:8081/ccp. The prefix depends on the domain name, type of CP, and branding in your system.

For example, if the application ID is http://isv1.example/apps/basic, the direct link to the servers item will look as follows:

/i/isv1.example/apps/basic/servers

If the same application contains a server edit view, for example, the view ID is server.edit, and you need to open a VPS, whose APS ID is bad5a936-9898-442c-a4de-d676c05dc0b8, the direct link will be:

/v/isv1.example/apps/basic/server.edit/r/bad5a936-9898-442c-a4de-d676c05dc0b8

Warning

When adding a list of parameters after the ? symbol in a direct link, keep in mind that due to a known bug in Internet Explorer the IE (version 11 and older) browser does not allow to use internationalized characters. Get more explanations if necessary.

Requirements

Direct links must comply with the following requirements:

• Usage of the % char is not allowed.

• For simplicity, the following substitutions must be used:

  • pa instead of www.parallels.com

  • aps instead of aps-standard.org

Examples

• Direct link to the domains view in the platform application whose ID is http://www.parallels.com/ccp-domains looks as follows:

  /v/pa/ccp-domains/domains
  

  

• The servers view in the demo VPS cloud application whose ID is http://aps-standard.org/samples/basic1p is available through this direct link:

  /v/aps/samples/basic1p/servers
  

• To view all users:

  /v/pa/ccp-users/usersview
  

• To edit a user:

  v/pa/ccp-users/viewUser/r/92a4beea-ab07-492b-a893-166941da5d78
  

• To create a user:

  /v/pa/ccp-users/addUser
  

• Direct links as defined in the notification demo look as follows:

  $notification->link = new \APS\NotificationLink(
      "/v/aps/samples/async1pn/servers/",                      // Main link
      "/v/aps/samples/async1pn/server-edit/r/".$this->aps->id, // Link more
      "View or edit VPS"                                       // Link more text
  );
  

← Controls

Single Page Application →