Submit a request

App URL Structure

Avatar
Kepion Support
  • Updated

In this article, let’s take a look at the structure of a Dashboard App URL, and features we can use to direct users to different Dashboard Apps and submissions. Furthermore, we’ll briefly look at System Variables to assist in redirects.

 

main.png

 

 

Structure

http://localhost:8888/?ui=js&page=contributor&appid=1&authid=1&subid=-1&mode=c&contextid=1

 

  • Host name
  • Port number
  • Application ID
    • A number assigned to each Application database when added to Kepion through the System Module.
  • Authorization ID
    • A number assigned to each Dashboard App in an Application when added through the Administrator Module.
  • Submission ID
    • A number assigned to each submission for a given Dashboard App. Set this to -1 to always access the first saved submission for a user.
  • Access Mode
    • The role the user has been configured for through the Administrator Module.
      • c – Contributor
      • r – Reviewer
      • a – Approver
  • Context ID
    • An optional value to specify which Dashboard page and Filters to select by default. See this article for more information.

 

 

System Variables

Kepion also features System Variables which can be utilized in the same way as other Standard Variables. The key difference being that System Variables will always resolve to the system-defined term, even if overridden with a user-defined variable.

 

These variables are:

 

Variable Definition
${user} The user currently logged in
${plan} The plan name
${submission} The submission name
${subid} The submission ID
${page} The current dashboard page context
${contributor-page} The relative path to the HTML5 version of Kepion.
${contributor-page-no-splash} The same as the above, but without the Kepion splash page.

 

Tip: Learn more about System Variables in this article. 

 

For example, if you replace the path to the Silverlight/HTML5 version with the variable ${contributor-page}, the URL will automatically resolve to whichever version the user is currently in, as seen in the window below.

 

pagecontributor.PNG

 

Likewise, the table below demonstrates what the final URL will look like depending on which environment the APP is currently in.

 
http://localhost:8888/${contributor-page}&app...
 
Version Resolves to
Silverlight http://localhost:8888/#/contributor?&app...
HTML5 http://localhost:8888/?ui=js&page=contributor&app...

 

Similarly, the variable ${contributor-page-no-splash} functions in exactly the same way, however it doesn’t load the splash page. Unless it’s necessary for a link to directly reference a specific version, it’s considered best practice in Kepion to always format URLs with these variables. In addition, it’s often preferred to remove the splash page when switching between Apps in this context.

Related articles