Basic Site Settings

Configure site settings such as site URL, contact email address, and themes.

Note: this section contains information about the configuration settings defined within the Akana API Platform, which apply to the entire developer portal.

For information about the configuration settings defined in the Akana Administration Console, which apply only to the specific container, refer to Admin Console Settings.

Table of Contents

  1. How do I configure site settings?
  2. How do I add a theme?
  3. How do I edit a theme?
  4. How do I delete a theme?
  5. How do I configure values for a theme?
  6. Lifecycle Manager: special instructions for running with MS SQL Server
  7. Related Topics

How do I configure site settings?

API Platform Version: 8.3

Key values relating to your implementation of the developer portal, such as the contact email address used in emails and notifications sent out by the system, are generally set up as part of the Jython script that's run as part of installation. However, you might want to change one or more of these values later.

Some of these settings, you can configure in the Site Settings page.

You can also add or modify platform themes on this page.

This setting... Controls this feature...
Name

A friendly name for the tenant (can be more than one word), used in emails and notifications that are sent out by the system. It should reflect the name of your site.

Corresponds to the tenantName element in the installation Jython script.

Site Contact Email

The email address used in any "contact us" context for the developer portal, including certain emails and notifications that include contact information.

Corresponds to the contactEmailAddress element in the installation Jython script.

From Email

The email address displayed in the "From" field for email notifications sent out by the platform.

Corresponds to the fromEmailAddress element in the installation Jython script.

Limit forward proxy feature to allow only these hosts

Optional security feature. Default (*) means that Test Client will forward API calls to any valid host. If you specify one or more hosts, Test Client will forward API calls only to these trusted hosts. To allow multiple hosts, use a comma separator; for example, host1, host2, host3, or acmepaymentscorp.com,acmepaymentscorp.co.uk.

Note: There is a setting in the Akana Administration Console relating to forward proxy hosts, and that field takes precedence over this one. It must be set to the default, * (allow all) in order for values specified in the developer portal site settings to apply. For information on the Akana Administration Console setting, see com.soa.atmosphere.forwardproxy.

Default Console Address

The full URL that will be used in the browser when accessing the developer portal user interface. The browser then redirects to the default login page.

Corresponds to the consoleAddress element in the installation Jython script.

Google Analytics Account ID To add Google Analytics automatically to your site pages, provide your Account ID.
Lifecycle Manager Integration If enabled, properties defined for assets in the developer portal, such as apps and APIs, can be extended by modifying templates in an integrated Lifecycle Manager. For more information, see Using Custom Metadata on the Developer Portal. For information about special steps to take if you're using Lifecycle Manager with a SQL Server database, see Lifecycle Manager: special instructions for running with MS SQL.
Themes

Current themes for the tenant are displayed. You can:

  • Add a theme: click Add Theme. See How do I add a theme?
  • Edit a theme: On the line for the theme you want to edit, click the Actions arrow at the right and choose Edit Theme. See How do I edit a theme?
  • Delete a theme: On the line for the theme you want to delete, click the Actions arrow at the right and choose Delete Theme. See How do I delete a theme?
To configure site settings:
  1. Log in as the Site Admin.
  2. Go to Administration > Site.
  3. Change the settings as needed. For explanations of your choices, refer to the table above.
  4. When done, click Save.

Back to top

How do I add a theme?

API Platform Version: 8.3

You can add one or more themes in the Site Settings.

To add a theme:
  1. Log in as the Site Admin.
  2. Go to Administration > Site.
  3. At the bottom, in the Themes section, click Add Theme.
  4. Specify settings (for help with field values, see How do I configure values for a theme? below):
    • Choose Standard Theme (Hermosa, Simple Dev. or Default), or Custom Theme (specify a custom theme name, and specify the theme it's based on).
    • Specify one or more comma-delimited virtual hosts for the theme.
    • Specify the full console address for the theme, including trailing backslash.
    • Specify the site title. This is important for SEO rankings.
    • Specify the site meta description.
  5. Click Finish.
  6. On the Site Settings page, click Save to confirm.

Back to top

How do I edit a theme?

API Platform Version: 8.3

You can edit a theme in the Site Settings.

To edit a theme:
  1. Log in as the Site Admin.
  2. Go to Administration > Site.
  3. At the bottom, in the Themes section, find the theme you want to modify.
  4. To the right of the line, click the Actions icon and choose Edit Theme.
  5. In the Edit Theme overlay, modify settings as needed. For help with field values, see How do I configure values for a theme? below.
  6. Click Finish.
  7. On the Site Settings page, click Save to confirm the change.

Back to top

How do I delete a theme?

API Platform Version: 8.3

You can delete a theme in the Site Settings.

To delete a theme:
  1. Log in as the Site Admin.
  2. Go to Administration > Site.
  3. At the bottom, in the Themes section, find the theme you want to delete.
  4. To the right of the line, click the Actions icon and choose Delete Theme.
  5. From the Site Settings page, click Save to confirm the deletion.

Back to top

How do I configure values for a theme?

API Platform Version: 8.3

In Site Settings, you can add, edit, or delete a theme.

The values in the Add/Edit Theme overlay are explained below.

Add/Edit Theme Settings
Field Description
Theme: Standard Standard themes are out-of-the-box themes that ship with the product; however, they must be specifically installed.
Theme Name

If you choose Standard Theme, choose a name out of the list of out-of-the-box themes available: simpledev, hermosa, or default.

Note: If the theme you want is not available for selection, ask the System Administrator to install it.

Theme: Custom

Naming a custom theme allows you to define a new theme, based on an out-of-the box theme. You can then apply customization to the custom theme without affecting the out-of-the-box theme itself. Choose a simple theme name without spaces or special characters.

Theme Name

Custom themes allow you to have a different branding on a different virtual host for the same theme. The custom theme name is used in the path of the uploaded resources for the theme. If you choose Custom Theme, specify the out-of-the-box theme it will be based on. Available choices: simpledev or default. Currently, Hermosa Theme cannot be cloned. You can apply customization to Hermosa Theme itself, but you can only have one instance.

Virtual Hosts / Vanity Hostnames A comma-delimited list of all hostnames that will be used to access the site (for example, vanity.example.com,other.example.com). The system uses these hostnames to determine which theme to present. In your DNS system, make sure there is an A record or CNAME record for each virtual hostname, and that it points to your system.
Console Address The full URL for the site. As well as browser access, the console address is used in links to the site in various emails and notifications. Must be a full URL, including scheme, hostname, context path, and trailing forward slash; for example, https://vanity.example.com/site/.
Site Title The page title for the site. This is the most important on-page SEO element, and typically appears in the browser tab and search engine results. Relevant keywords should be placed first in the title, with branded information at the end. Keywords earlier in the title are given greater importance and will positively impact your organic rankings and traffic. Page titles should ideally be no more than 60 characters long to ensure they're not truncated on desktop, mobile & tablet searches.
Site Meta Description The meta description for the site. This is used by search engines. The description should lead with an explanation of what the site is about, followed by a call to action. It should be no more than 155 characters so that it isn't truncated in search results.

Back to top

Lifecycle Manager: special instructions for running with MS SQL

When the API Platform is using a Microsoft SQL Server database, when you initially enable the Lifecycle Manager Integration option in the Site Settings (see Lifecycle Manager Integration), this action fails to create the backing Lifecycle Manager library for the tenant.

To address this issue, you’ll need to enable a setting in the Akana Administration Console for the container, before enabling the Lifecycle Manager Integration site setting. Follow the steps below.

To enable synchronization of Lifecycle Manager data in the Akana Administration Console
  1. In the Akana Administration Console, on the Configuration tab, under Configuration Actions, choose Synchronize Lifecycle Manager Data. The wizard opens.
  2. Enter the name of a specific tenant, or leave empty for all tenants, and run the configuration action.
  3. When done, click Finish.

For more information on running this configuration action, see Synchronize Lifecycle Manager Data (Admin Console documentation).

Back to top