Customizing the Apprenda Platform User Interfaces (White Labeling)

Avatar
Matt
Follow

Apprenda ships with several core user interfaces that are used by various platform constituents:

  1. The Developer Portal is used by developers who produce applications and services and deploy them on the platform.
  2. The Account Portal may be used by application end users to manage their accounts and organizational (tenant) information.
  3. Authentication – the screens that all end users of the platform use to login, create accounts, retrieve forgotten passwords, and more.

These three interfaces are the three interfaces accessible by constituents other than the platform operator.  Therefore, a platform operator may want to customize (“white label”) these interfaces to provide their customers (developer and end users) with a branded look and feel.

The Apprenda license prohibits platform operators from modifying platform source code, including HTML output.  However, we provide platform settings that allow operators to overlay CSS and JavaScript atop these three user interfaces – and with CSS and JavaScript a wide array of customizations are possible.

The approach to applying customizations has three steps:

  1. Create CSS style sheets and JavaScript libraries (if necessary) – we recommend using a tool like the web development tools built into the Chrome browser to inspect the HTML output from the platform and write CSS overrides where desired.  Likewise, JavaScript can be used to hide/show/modify output content.
  2. Host your style sheets and JS files either off platform or within a dedicated app on the platform (which will give you a known URL and the ability manage these resources through Apprenda lifecycle management – make sure you choose no platform services for this app).  For example, you may deploy an app containing all customization resources at http://apps.myapprenda.com/customresources
  3. Use the Platform Registry in the SOC to provide URLs to these resources. The platform will overlay your customizations once these settings are in place:
    1. Developer Portal
      1. CSS - @DeveloperPortalCssOverrideUrl
      2. JS - @DeveloperJsOverrideUrl
    2. Account Portal
      1. CSS - @AccountPortalCssOverrideUrl
      2. JS - @AccountPortalJsOverrideUrl
    3. Authentication
      1. CSS - @AuthenticationCssOverrideUrls
      2. JS - @AuthenticationJsOverrideUrls

Each one of these Platform Registry settings is a comma delimited list of resource URLs.  The platform will overlay them in the order that they are listed.  For more information about modifying the Platform Registry, see: http://docs.apprenda.com/current/managing-registry

Have more questions? Submit a request

Comments