AppSuite:Embedding your settings into AppSuite settings

From Open-Xchange


Embedding your settings into AppSuite settings

Synopsis: This article explains how you can embed your own configuration page via iFrame into the AppSuite's settings and pass our session onto your implementation. This is a replacement for "Config Jump" of OX6. Not to be confused with simply adding new settings into AppSuite


Declare the page you want to embed

Before you start you need to know the group where you want to add the settings (since 7.8.0): 

gerneral:
Basic Settings
Accounts

main:
Portal
Mail
Guard
Address Book
Calendar
Tasks
Drive

tools:
Pubications and Subscriptions
Error Log
Download

external:
Groups
Resources

Note: the layout of the settings page might differ depending on which packages you have installed and/or which capabilities the user has.

You can declare pages to embed via Config Cascade settings. There are several ways to do so, this example uses the most comfortable one, a YAML declaration: 

➜ /opt/open-xchange/etc/settings/configjump.yml
io.ox/settings/configjump//changePlans:
   url: "http://localhost/~fla/changePlans.php?token=[token]"
   group: general
   title: "Change Plan"
   before: "io.ox/settings/accounts"
   advancedMode: false # not needed anymore for 7.8.0

io.ox/settings/configjump contains one object per embedded page (e.g. "changePlans"). If you want to add more pages, follow this pattern.

An object of this type has the following properties:

  • url: The URL to be branched to. The place holder [token] will be replaced by the token you get from the token login system
  • title: The title as to be seen on the settings page.
  • group: Settings section where the page is supposed to appear. Valid groups are: "general", "main", "tools", and "external". Default is "tools". For settings inside folders you have to use the group and the name of the config object, for example: group: main/io.ox/mail
  • after, before or index: To define the exact location of the page. Hint: If you want to name a page as reference (as opposed to using the index), you need to figure out the name. One way to do so is go to that page in the settings and check for the id parameter in the URL (for example http://my.ox/appsuite/#!!&app=io.ox/settings&folder=virtual/settings/io.ox/tasks will be io.ox/tasks)
  • requires: A string of capabilities. Supports boolean operators like && (AND), || (OR), ! (NOT), as well as parentheses. Example: !guest.

It's also possible to provide custom translations for the title. Just add "title_" plus the locale: 

io.ox/settings/configjump//changePlans:
   url: "http://localhost/~fla/changePlans.php?token=[token]"
   title: "Change Plan"
   title_en_US: "Change plan"
   title_de_DE: "Plan ändern"
   title_fr_FR: "..."
   ...
   after: "io.ox/mail"

Create a secret

Now you just need to declare the app your are about to embed in the backend and you are good to go: 

➜ cat /opt/open-xchange/etc/tokenlogin-secrets
#
# Listing of known Web Application secrets followed by an optional semicolon-separated parameter list
#
# e.g. 1254654698621354; accessPasword=true
#

# Dummy entry
# 1234-56789-98765-4321; accessPassword=true
12345-phpapp-54321

This secret, combined with the token, can be traded for a login.

Redeem a token

GET /login?action=redeemToken
  • token: The token you want to trade.
  • secret: A valid secret for your app.

This request can be sent by the embedded app to the AppSuite backend to get authorisation info.


Stuck somewhere?

You got stuck with a problem while developing? OXpedia might help you out with the article about debugging the UI.

Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Embedding_your_settings_into_AppSuite_settings&oldid=21625"