The Service Insertion Framework allows you to bring other portals into OnApp. Also, you can integrate an insertion framework into OnApp, which will display a web page within the user profile in the OnApp Control Panel (legacy mode). 

  • Ensure that the Service Insertion Groups and Service Insertion Pages permissions are on before managing service insertion framework. For more information, refer to the OnApp Permissions section of this guide.
  • Be aware that insertion framework may not be shown when header has X-Frame-Options. User can be logged in only if embedded source accepts credentials via GET request.

Configure Service Insertion Framework

To configure a service insertion framework:

  1. Create service insertion group, which is a container for service insertion pages. Service insertion group which is available for a chosen audience.
  2. Create service insertion page(s), where you will add a URL, which will be displayed in the frame.
  3. When service insertion groups and pages are configured, they will appear at Control Panel sidebar menu. Click the service insertion page's label to display the page in the main content panel.

Below you can find detailed information on how to create and manage service insertion groups and pages.

Service Insertion Groups

Create Service Insertion Group

To create a service insertion group:

  1. Log in to your OnApp Control Panel.
  2. Go to Admin > Settings > Look & Feel icon.
  3. On the page that loads, click the Service Insertion Framework > Service Insertion Groups tab.
  4. On the following page, click upper right or the Add Service Insertion Group button lower right.
  5. Fill in the following fields:
    • Label - fill in the name for service insertion group
    • Weight - select value from 10 to 0 to determine which group comes first.  If all groups are weighted the same, then the list is displayed based on order retrieved from the database.
    • Target - choose the audience, which your service insertion group will be available to:
      • Global -  service insertion group will be available to all users
      • User  - Users field appears, where you indicate user(s), whom your service insertion group will be available to
      • User group - the User groups field appears, where you indicate user group(s), to which your service insertion group will be available
  6. Click Submit.


Edit Service Insertion Group

To edit a service insertion group:

  1. Go to your OnApp Control Panel > Admin > Settings > Look & Feel icon.
  2. On the page that loads, click the Service Insertion Framework > Service Insertion Groups tab.
  3. The list of all service insertion groups will load. Click the Actions icon next to the required service insertion group, and click Edit or Delete if necessary to edit or remove the group respectively.

Service Insertion Pages

Create Service Insertion Page

To create a service insertion page:

  1. Go to your OnApp Control Panel > Admin > Settings > Look & Feel icon.
  2. On the page that loads, click the Service Insertion Framework > Service Insertion Pages tab.
  3. On the following page, click upper right or the Add Service Insertion Page button lower right.
  4. Fill in the following fields:
    • Label - fill in the name for the service insertion page
    • URL - add URL, which will be displayed in the frame
    • Legacy mode - move the slider to the right to enable legacy mode and fill in the corresponding fields:
      • Users - select the appropriate users whose username will be used to form an URL
      • User field parameter - fill in the user field label
      • User field - select the required user parameter value from the drop-down list. This could be a login, email etc.
      • Password field parameter - fill in the password field label
      • Password field - select the password field value from the drop-down menu. These are the Additional fields of the specified user.

  5. If a legacy mode is disabled, fill in the following:
    • Weight - select from 10 to 0 to determine which page comes first in the group. If all pages are weighted the same, then the list is displayed based on order retrieved from the database.
    • Service insertion groups - assign page to service insertion group(s)
    • Choose one of the credentials types (Global static, User based or User group based) from the drop-down list and fill in the corresponding fields:
      • User field parameter - fill in the user field label
      • User field - select the required user parameter value from the drop-down list. This could be a login, email, etc.
      • Password field parameter - fill in the password field label
      • Password field - select the password field value from the drop-down menu. These are the Additional fields of the specified user.

    If you want to clean all fields and restart the creation process, click the Reset Form Fields button.

  6. Click Submit.

Edit Service Insertion Page

To edit a service insertion page:

  1. Go to your OnApp Control Panel > Admin > Settings > Look & Feel icon.
  2. On the page that loads, click the Service Insertion Framework > Service Insertion Pages tab.
  3. The list of all  service insertion pages will load. Click the Actions icon next to the required service insertion page, and click Edit or Delete if necessary to edit or remove the group respectively.

See also: