Configuring the Service Portal

The Service Portal provides a self-service interface for users to request new services or changes to existing services.

There are a number of configuration changes that you can make to affect users' experience when they sign in to the Service Portal.

In this topic:

You can also create a fully branded Service Portal experience for end users. For more information, see Branding the Service Portal.

Controlling what users see in the Service Portal dashboard

The Service Portal dashboard displays service request status, resource and performance information, and cost details. Visibility of this information is determined by permissions, so you can control what information users see. If a user doesn't have permission to see costs, for example, the Costs widget won't appear on their home page.

Permissions for Controlling What Users See on the Service Portal Home Page

Dashboard widget

Service Portal permission

Service Requests

Request New Service or Request Service Change (either is sufficient)

My Resources

Always visible; not controlled by permissions

VM Performance

Show Performance Tab

Cost

Show Cost

See Customizing Service Portal Roles for End Users to learn how to edit permissions.

Displaying your logos in the Service Portal

To provide a personalized user experience, you can replace the default logos that appear in the Service Portal with your organization's custom logos. The following logos can be replaced:

  • Primary logo: Appears on the sign in page for the Service Portal, in email notifications, and reports. For optimal results, use a PNG or JPG image that's 250 pixels by 80 pixels.
  • Banner logo: Appears on the top left corner of the Service Portal. For optimal results, use a PNG or JPG image that's 150 pixels by 50 pixels.

Note: If you've configured a custom theme prior to upgrading, the images used with the theme will display as the Service Portal logos. For more information about custom themes, see Branding the Service Portal.

Access through:

Configuration > System

Available to:

Commander Role of Superuser

To change the Service Portal logos:

  1. Click the Portal tab.
  2. In the Service Portal Logos section, do the following for each service portal logo:
    1. Select an image.

      A preview of the image displays.

    2. Click Save to apply the image.

    The logos appear in the Service Portal the next time a Service Portal user logs in.

Note: The logos you upload are not impacted if you upgrade.

Displaying a message of the day in the Service Portal

You can display a message in the Service Portal to notify users of an impending service outage, for example.

Message of the Day

All Service Portal users will see the message when they sign in; after they click OK, the home page is displayed. The Message of the Day is displayed on every sign in until you change or remove it.

Access through:

Configuration > System > Portal tab

Available to:

Commander Role of Superuser

  • To display a Message of the Day in the Service Portal, under Service Portal Message of the Day, enter a maximum of 1000 characters, and click Save Settings.

    Line breaks are preserved, but other formatting isn't applied to the message.

  • To remove the Message of the Day, delete the text, and click Save Settings.

Selecting Service Portal landing pages

You can select what landing page that a user will see when they initially sign in to the Service Portal as a member of an organization.

Each organization that a user belongs to can have its own dedicated landing page.

You can select one of the following Service Portal landing pages for an organization:

  • Dashboard
  • Cost Dashboard
  • Service Catalog
  • External Page

Note that users must have the appropriate Service Portal permissions to view some landing pages.

Permissions Required to View Service Portal Landing Pages

Landing page

Service Portal permission

Dashboard

Show Dashboard

Cost Dashboard

Show Cost Dashboard

Service Catalog

NA. The Service Catalog doesn't require a Service Portal permission.

External Page

Show External Page

See Customizing Service Portal Roles for Users to learn how to edit user permissions.

Access through:

Configuration > Identity and Access

Available to:

Commander Role of Superuser

To select a landing page for an organization:

  1. Click the Organizations tab.
  2. Select an organization.
  3. Click Edit.
  4. In the Configure Organization wizard, click Next to get to the Organization Properties page.
  5. On the Organization Properties page, select the Landing Page.
  6. Click Finish.

Displaying credits and taxes in the Service Portal Cost Dashboard

Show or hide cloud credit and tax information from Service Portal Cost Dashboard users. This setting doesn't affect how costs are displayed in Commander Cost Analytics.

Access through:

Configuration > Identity and Access

Available to:

Commander Role of Superuser

To show or hide cloud credit and tax information from Service Portal Cost Dashboard users:

  1. Click the Organizations tab.
  2. Select an organization.
  3. Click Edit.
  4. In the Configure Organization wizard, click Next to get to the Organization Properties page.
  5. On the Organization Properties page, for Cost Dashboard, select Show cloud credits and taxes or Hide cloud credits and taxes.
  6. Click Finish.

Providing access to external web pages

You can provide users with access to an external web page in the Service Portal.

For example, you could label the menu item as "Company Intranet" for easy access to your company intranet. You could also build a separate website with access from the Service Portal or you can point the external page to any other system such as SharePoint or QuickBase.

The title that you enter shows up on the top or bottom of the Service Portal left menu for users with the Show External Page permission.

The external page is displayed inside an iframe. Note the following related limitations:

  • If Use Proxy is disabled, the external page must allow rendering inside iframes. See X-Frame-Options for more information.
  • You can customize the iframe height. See Branding the Service Portal to learn how to customize the Service Portal theme.
  • If Use Proxy is enabled, users must access the Service Portal using the fully qualified domain name (FQDN).

Best Practice: If you set up access to an external web page after users have started using the Service Portal, notify them that they must sign out and sign back in to the Service Portal for the external web page to become available to them.

Access through:

Configuration > System

Available to:

Commander Role of Superuser

To provide access to an external web page:

  1. Click the Portal tab.
  2. In the Custom External Page section, enter a title and enter a URL that includes the prefix http:// or https://.
  3. If you want to use the embedded Service Portal proxy server, enable Use Proxy, then choose the system credentials that will be required.

    Note: The external web page can have a self-signed certificate. For information on adding and managing system credentials, see Managing Credentials.

  4. Set the position for the page title on the Service Portal menu. The default is at the bottom of the menu.
  5. Click Save Settings.

To set the custom external page as the Service Portal landing page, see Selecting Service Portal landing pages.

Note: To delete a custom external page, remove the URL.

Providing access to external VM-specific information

Using Commander variables, such as custom attribute variables, you can retrieve VM-specific information from a third-party system and display it on the VM details page in the Service Portal. For example, you can provide access to third-party VM performance metrics.

Users must have the Show External Page permission to see external information.

The external information is displayed inside an iframe. Note the following related limitations:

  • If Use Proxy is disabled, the external resource must allow rendering inside iframes. See X-Frame-Options for more information.

    The height of the iframe is fixed, but you can customize it through your custom theme. See Branding the Service Portal.

  • If Use Proxy is enabled, users must access the Service Portal using the FQDN.

Best Practice: If you set up access to an external web page after users have started using the Service Portal, notify them that they must sign out and sign back in to the Service Portal for the external web page to become available to them.

Access through:

Configuration > System

Available to:

Commander Role of Superuser

To provide access to external VM-specific information:

  1. Click the Portal tab.
  2. In the Custom External Information for VMs section, provide a title that will be displayed in the Service Portal.
  3. Enter a URL with the prefix http:// or https:/.

    Tip: In any text field that supports variables, you can click to open the script editor and select variables for the current context.

  4. To use a proxy server, enable Use Proxy.

    Note: The external resource can have a self-signed certificate.

  5. If your proxy server requires authentication:
    • Choose the appropriate credentials from the Credentials menu, or
    • Click Add Credentials to add the associated system credentials. See Managing Credentials to learn more.

Displaying the DNS and VM name in the Service Portal tree

Service Portal users can identify their VMs by DNS name in addition to VM name. The setting is controlled by a user preference under Tools > Preferences. When the preference is enabled, the DNS name is displayed in parentheses to the right of the VM name in the tree view.

By default, this preference is disabled. You can edit the system property embotics.portal.tree.show.dns to enable the preference by default on first sign in. To learn how to edit system properties, see Advanced Configuration through System Properties.