How to add web portals and pages to the OnApp cloud management UI
With OnApp’s Service Insertion Framework, you can create your own custom sections on the left-hand toolbar in the OnApp control panel, to provide access to any website or web portal you choose from within the OnApp UI. For example, a support system, knowledgebase or billing system.
You can even log users into embedded websites automatically, so you can use the OnApp interface as a way to access other services as a seamless part of your cloud.
Here’s an example with https://onapp.com running as a service inserted into the OnApp UI:
The Service Insertion Framework feature is available from OnApp v5.5. If you’ve upgraded to version 5.5 and you do not see the option for Service Insertion Framework under ‘Settings -> Look & Feel’ then you may need to enable the permissions for your user role. You can do that by editing your Role – see how at https://docs.onapp.com/display/55AG/Edit+Role
How to set up your Service Insertion Framework
Here’s a quick guide to setting this up.
1. Create a Service Insertion Group
To start with, we’ll need to create a Service Insertion Group, which acts as a container for one or more third party websites (“Service Insertion Pages”) in OnApp.
- Go to the Look & Feel section of your Settings screen – up top you should see the “Service Insertion Framework” tab
- From that tab, select the “Service Insertion Groups” option and click the + button to add a new group.This will load up a form asking for:
- Label (what to display as the name for the group)
- Weight (determines the order of groups in the UI, from 10 to 0)
- Target, with 3 options:
- Global shows the links to all users
- User lets you choose specific users that links will be visible to
- User group lets you choose specific user groups that links will be visible to
- Click Submit to create the group
2. Create Service Insertion Pages
Once you have a Service Insertion Group, you can start adding web pages inside that group.
- Go back the Look & Feel section of your Settings screen, and click the “Service Insertion Framework” tab again
- From that tab, select the “Service Insertion Pages” option and click the + button to add a new group. This will load up a form asking for:
- Label – what to display as the name for the page in the OnApp UI
- URL – the web page address
- Legacy mode – uses OnApp’s previous method of displaying web pages inside the UI, where specific users get access to a page from their User Profile under the “more” tab, instead of via the left-hand toolbar in the main UI.
If you select Legacy you’ll need to choose which users have access to this page from the selection menu that’ll appear. If you don’t want legacy mode, instead you can configure:
- Weight (determines the order of the page inside the service insertion group, from 0 to 10)
- Service insertion groups – which groups this page is a member of
Here’s where you set the log-in credentials for the web page, if you need to – these are optional. If you use Credentials, then set:
- Credentials type (not required in legacy mode)
- Global static – use the same values for every user – e.g. for when you have one account that should be used across the board for a given third party website
- User based – use specific values for individual users – for when each user has their own account at the website in question
- User group based – use specific values for groups of users
- Credentials type (not required in legacy mode)
Then, fill out the following fields:
- User field parameter – the name of the user field parameter, e.g. ‘Username’, ‘user’, ‘login’ etc – that will be used with the page
- User field – the data that the user field parameter should contain
- Password field parameter – the name of the password field parameter that will be used with the page – e.g. ‘password’
- Password field – the data that the password field parameter should contain
When the credentials type is ‘user based’, the user field and password field become drop-down menus, where you can decide which OnApp field for that user, should be used.
For the password field, you may need to create a new field for the user, which you can do by clicking the Users link in OnApp’s left-hand toolbar, selecting a user, and then clicking the “User Additional Fields” button. These additional fields can be created by an admin or by a user, depending on their permissions.
When the credentials type is ‘user group’, you’ll be setting the login and password details for specific OnApp User Groups. Any user who is part of that group will then be logged into the page using those credentials.
When the user group option is selected, the user and password field dropdowns will let you choose from the User Group Additional Fields configured for the user group in question. To create these, click the Groups link in OnApp’s left-hand toolbar, select a group, and then clicking the “User Group Additional Fields” button.
- Click Submit to finish adding the page to the Service Insertion Group.
The page you set up should then appear in OnApp’s left-hand toolbar, under the heading of the name of the group you created it in: