...

dRofus web application offers integration through embedding, in which the embedder clients can display dRofus data panels inside their application space. dRofus integrated application runs in a browser context and expected to be embedded through HTML iframe or run in a browser widget (e.g. WebView on Android, BrowserControl for C#/WPF) in app.

Remarks for apps

1. integrated dRofus uses browser cache to boost startup performance, application assets (static files like html, css, javascript, images, etc.) are only being loaded first time (or if changed) and subsequent startups are being served from browser cache. To utilize this in apps, make sure browser widget cache is not being discarded if the application is closed.
2. In some cases, integrated dRofus opens a new browser tab/window (when downloading files or opening the full dRofus webapp with the same context). Browser widgets default implementation is ignoring such external navigation (target="_blank") Embedders should implement then handle such event, for example in WPF WebView, NewWindowRequested event.

Login and startup

Anchor
login_startup login_startup

dRofus applications, both web and desktop, require a logged in user. At login, username, password and project selection is required. Project selection consists of selecting server, database and project (if multiple configured in a database).

Image Modified

Login to dRofus integrated application relies on OIDC-standard. The following steps summarizes the login workflow:

...

The path of entry point to our dRofus integrated application is: /embedded on the corresponding application server. Application requires a logged in user, please do login first!Client side urls of dRofus integrated application are currently being designed, will be added to this documentation once ready.

Frontend Urls

• #/rooms/search?value={searchValue}

  #/rooms/search/{attributeId}?value={searchValue}

  Searches for rooms. If single result, shows the detail panel. If multiple, a selector is shown

  Parameters

  • searchValue: Defines what to search fro
  • attributeId: Optional parameter defining which field to search in

• #/rooms/room/{roomId}

  Shows room detail panel

  Parameters

  • roomId: Drofus room identifier (integer number)

• #/articles/search?value={searchValue}

  #/articles/search/{attributeId}?value={searchValue}

  Searches for items. If single result, shows the detail panel. If multiple, a selector is shown

  Parameters

  • searchValue: Defines what to search fro
  • attributeId: Optional parameter defining which field to search in

• #/articles/article/{articleId}

  Shows item detail panel

  Parameters

  • articleId: Drofus article identifier (integer number)

• #/occurrences/search?value={searchValue}

  #/occurrences/search/{attributeId}?value={searchValue}

  Searches for occurrences. If single result, shows the detail panel. If multiple, a selector is shown

  Parameters

  • searchValue: Defines what to search fro
  • attributeId: Optional parameter defining which field to search in

• #/occurrences/occurrence/{occurrenceId}

  Shows occurrence detail panel

  Parameters

  • occurrenceId: Drofus occurrence identifier (integer number)