Landing Pages for Solutions

overview developers can enhance the user experience by configuring landing pages for their solutions landing pages direct users to specific pages within the solution based on their user group or a default setting this guide will walk you through the process of setting up and managing landing pages for your solutions landing page behavior when a user accesses your solution, the landing page they are directed to is determined by the following rules, in order of precedence if the user belongs to a single user group and that group has a landing page configured in the solution level manifest file , the user will be directed to that landing page if the user belongs to multiple user groups with configured landing pages, the user will be directed to the landing page of the user group with the highest priority (lowest rank value) if no user group specific landing page matches the user's groups, if set, the default landing page configured will be used if no landing pages are configured (user group specific or solution default), the user will be directed to the first accessible app in their console sidebar configuring landing pages there are two types of landing pages you can configure for your solution default landing page a single, default landing page for all users accessing your solution user group landing pages specific landing pages for different user groups within your solution default landing page to set a default landing page for your solution call registersolution https //docs getos1 com/reference/register solution or updatesolution https //docs getos1 com/reference/update solution in the request body, include the solnurls object with the url of your desired default landing page example { "solnurls" \[ { "name" "landingpage", "url" "https //www example com/default landing page" } ] } in this example, the solnurls object contains an object with two properties name set to landingpage to indicate that this url represents the default landing page for the solution url the url of the default landing page, in this case, " https //www example com/default landing page https //www example com/default landing page " if you configure a default landing page, it will direct users to this page when they access your solution, unless a user group specific landing page is defined and takes precedence user group landing pages to configure landing pages for specific user groups call downloadartifact https //docs getos1 com/reference/download the artifact for an appsoln version given artifact id to download your solution manifest file https //docs getos1 com/automatic creation of user groups and roles for apps#r2i q for each user group you want to configure a landing page for, add a landingpage attribute under the usergroupsrequired definition this attribute should contain two properties url the relative path to the landing page for this user group rank a positive integer indicating the priority of this user group in case the user belongs to more than one user group lower values have higher priority for example, rank 1 is a higher priority than rank 3 here's an example manifest file with user group landing page configurations solutionid my solution usergroupsrequired \ name admin description administrative user group landingpage url /admin dashboard rank 1 roles \ platform\ role\ app1\ admin \ platform\ role\ app2\ admin \ name manager description manager user group landingpage url /manager view rank 2 roles \ platform\ role\ app1\ manager \ platform\ role\ app2\ manager save your updated manifest file and upload it using the uploadartifact https //docs getos1 com/reference/uploads an artifact for an app or a soln api onboard your solution https //docs getos1 com/onboarding apps and solutions the solution service will automatically configure the landing pages based on your manifest retrieving landing page configurations to retrieve the landing page configurations for the default solution landing page use the getsolution https //docs getos1 com/reference/get solution by solution id api to view the details in the solnurls object defined when registering or updating your solution for user group landing pages use the getartifacts https //docs getos1 com/reference/gets the artifacts for an app or a soln api to retrieve the manifest file contents, including the landing page urls and ranks for each user group updating landing pages follow the steps below to update the default landing page for your solution and the landing pages for specific user groups updating the default landing page to update the default landing page, call the updatesolution endpoint and include the updated solnurls array with the new default landing page url in the request body { "solnurls" \[ { "name" "landingpage", "url" "/updated default landing page" } ] } updating user group landing pages to update the landing pages for specific user groups edit the solution manifest yaml file and modify the landingpage attribute for the desired user groups call the uploadartifacts api https //docs getos1 com/reference/uploads an artifact for an app or a soln to upload the updated manifest file curl location 'https //api example com/developer/artifacts?artifacttype=manifest\&solutionversionid={solutionversionid}' \ form 'file=@"/path/to/updated manifest yaml"' 2\ update the solution version using the addsolutionversion https //docs getos1 com/reference/add a new version to a solution api curl location 'https //api example com/developer/solutions/{solutionversionid}/versions' \\ \ header 'content type application/json' \\ \ data '{ "version" "1 0 1" }' 3\ onboard the updated solution version to the tenant using the onboarding https //docs getos1 com/reference/onboard item to tenants without init sequence api with the forcecreateusergroup=true query parameter curl location 'https //api example com/developer/tenants/v2/onboarding?forcecreateusergroup=true' \\ \ header 'content type application/json' \\ \ data '{ "versionid" "{solutionversionid}", "tenantids" \[ "tenant1" ] }' after updating the landing page configurations, the changes will be reflected in your solution users will be directed to the updated landing pages based on their user groups and the new default landing page setting note remember to replace {solutionversionid} in the api endpoints with the actual version id of your solution removing user group landing pages if you need to remove previously configured landing pages from your solution, follow these steps removing the default landing page to remove the default landing page for your solution call the updatesolution https //docs getos1 com/reference/update solution api in the request body, pass null against the solnurls object name and url parameters example "solnurls" \[ { "name" null, "url" null } this will remove the default landing page configuration, and users will no longer be directed to the previously set default landing page when accessing your solution to remove landing pages for specific user groups call downloadartifact https //docs getos1 com/reference/download the artifact for an appsoln version given artifact id to download your solution manifest file https //docs getos1 com/automatic creation of user groups and roles for apps#r2i q locate the user groups for which you want to remove the landing page configuration remove the entire landingpage attribute and its sub properties (url and rank) from each relevant user group definition save your updated manifest file and upload it using the uploadartifact https //docs getos1 com/reference/uploads an artifact for an app or a soln api onboard your solution https //docs getos1 com/onboarding apps and solutions the solution service will automatically update the landing page configurations based on your manifest example solutionid my solution usergroupsrequired \ name admin description administrative user group roles \ platform\ role\ app1\ admin \ platform\ role\ app2\ admin \ name manager description manager user group roles \ platform\ role\ app1\ manager \ platform\ role\ app2\ manager after removing the landing page configurations, the landing page precedence rules will be re evaluated based on the remaining configurations if no landing pages are configured at all (neither user group specific nor solution default), users will be directed to the first accessible app in their console sidebar when accessing your solution