Application Mode
There is now a new mode for embedding Omni called Application that will allow an embed user to navigate through the content system, create new content, and share content with others in their entity.
The embedded system largely mirrors how Omni natively works for internal users. The key difference is that the Entity parameter will isolate your embed customers from each other and ensure that a user can only see and share content with others in their entity.
When Omni sees a new Entity value, we autogenerate a shared entity folder that only that entity can access. There are 2 permission controls for embed users:
- Connection role (determines if a user can create content, or only consume it)
- Content role to the shared entity folder (determines if a user can add/manage content for their entity)
New URL parameters
| Parameter | Accepted Values | Notes |
|---|---|---|
| Mode | APPLICATION or SINGLE_CONTENT | Application - allows embed users to access the full content system and navigate through the Omni app in an iframe Single content - only embeds an individual dashboard or workbook. No content navigation or app headers |
| Content path | /my – start on My Documents /dashboards/<dash_id> – start on a specific dashboard /w/<id> – start on a specific workbook /entity-folder – start on the shared entity folder /root – start on ‘Hub’ /favorites – not available yet | Starting page when the embed user logs into the iframe |
| Connection roles | RESTRICTED_QUERIER, VIEWER | Connection roles available for embed users. Restricted queriers can create new content, Viewers can only consume dashboards |
| Embed entity | <alphanumeric_value> | Parameter that groups embed users together This will also create the shared entity folder using whatever name is set in the value |
| Entity folder content role | VIEWER, EDITOR, or MANAGER | Specifies the content role the embed user will be given to their shared entity folder Viewer - can see content in shared folder, can’t save to it Editor - can see and save content in the shared folder Manager - can control other users’ permissions to the shared folder |
User / Permission Mapping
| User Type | Connection Role | Entity Folder Content Role |
|---|---|---|
| User can only consume content | VIEWER | VIEWER |
| User can create content, but only save it to their private folder Note: they can still share content with other users in their entity directly (which will appear in ‘shared with me’), it just can’t be saved to the shared folder | RESTRICTED QUERIER | VIEWER |
| User can create content, and optionally share it to their shared entity folder | RESTRICTED QUERIER | EDITOR or MANAGER |