Kiosk mode（信息亭模式(Kiosk mode)）

Kiosk mode gives builders the ability to enable long-lived, restricted sessions for Workshop applications, allowing them to be safely displayed for extended periods of time.

Kiosk mode sessions are read-only, meaning that Ontology write backs such as object edits and creations may not be triggered, and have scoped down permissions limiting the content viewable within a session. Details on what entities are included in a Kiosk mode session's scope are available here.

Configure kiosk mode for a Workshop module

Kiosk mode settings can be configured and managed per Organization from Control Panel.

Once a module has been added to the kiosk mode setting’s allowlist, builders with permissions to launch kiosk mode sessions can do so by navigating to the Advanced Functionalities section of the module’s Settings panel and enabling the Kiosk Mode toggle. The Open kiosk button will appear in the top right corner of the module. Selecting this button opens a modal that outlines the contents of the currently published version of the module that will be visible for the duration of the session. This includes object types, link types, functions, and other embedded Foundry applications. After reviewing the scope of the module’s content, select Launch session to start a kiosk mode session.

After kiosk mode has been configured and enabled for a module in both Control Panel and Workshop, you can also launch a kiosk mode session in view mode by selecting Open kiosk.

You can end a kiosk mode session by selecting Exit kiosk mode. Active kiosk mode sessions can also be ended by Administrators from the Session Launch History table found in the kiosk mode settings section of Control Panel.

Kiosk mode session scope

Permissions will be scoped down for a module in kiosk mode to limit the content that is viewable in an active session. As a result, the content you can view when a module is in kiosk mode may differ from the content you can view when in view or edit mode.

Content that will be viewable and in the scope of a kiosk mode session will be displayed in the Content in scope section of the Launch kiosk session modal. Note that nested entities from embedded Workshop modules will be automatically included and viewable in a kiosk mode session. However, nested entities from other embedded Foundry applications will be not automatically included.

Here are two examples to illustrate how Kiosk mode scopes down entity permissions to limit the content viewable in a session:

• A Vertex Graph embedded via the Vertex Graph widget may reference an object type that is not directly present within the Workshop module. This means that when a Kiosk mode session is launched, that object type will not be included in the session’s scope and will not be viewable when in Kiosk mode.
• A function that executes search around on an object type within a module may fail in Kiosk mode if the corresponding link type is not present within the Workshop module.

You can use the Launch kiosk session to determine which entities will be present or missing in kiosk mode. To include a missing entity in a kiosk mode session's scope, you can add a direct reference to the entity somewhere within the module.

Limitations

• Object types that are backed by a restricted view data source are not supported in kiosk mode.
• All embedded Slate applications are disabled for security purposes due to their ability to write back to the Ontology.
• When developing OSDK applications, it is the application builder's responsibility to ensure that the iframe's content manages authorization or tokens appropriately so the authorization remain valid for the entire duration of the kiosk session. Review refreshing an access token for more information.
• The standard inactivity timeout dialog still appears in kiosk mode sessions. While kiosk sessions are designed to be long-lived, they follow the platform's session timeout policies for security reasons.

---

中文翻译

信息亭模式(Kiosk mode)

信息亭模式允许构建者为Workshop应用程序启用长期、受限的会话，使其能够安全地长时间显示。

信息亭模式会话为只读模式，这意味着无法触发本体论(Ontology)的回写操作（如对象编辑和创建），并且权限范围被缩小，限制了会话中可查看的内容。关于信息亭模式会话范围内包含哪些实体的详细信息，请参见此处。

为Workshop模块配置信息亭模式

信息亭模式设置可在控制面板(Control Panel)中按组织(Organization)进行配置和管理。

一旦模块被添加到信息亭模式设置的允许列表中，拥有启动信息亭模式会话权限的构建者可以通过导航到模块设置(Settings)面板的高级功能(Advanced Functionalities)部分，并启用信息亭模式(Kiosk Mode)开关来启动会话。打开信息亭(Open kiosk)按钮将出现在模块的右上角。选择此按钮将打开一个模态框，概述当前已发布版本的模块内容，这些内容将在会话期间可见。这包括对象类型、链接类型、函数以及其他嵌入的Foundry应用程序。查看模块内容范围后，选择启动会话(Launch session)以开始信息亭模式会话。

在控制面板和Workshop中为模块配置并启用信息亭模式后，您还可以在查看模式下通过选择打开信息亭(Open kiosk)来启动信息亭模式会话。

您可以通过选择退出信息亭模式(Exit kiosk mode)来结束信息亭模式会话。管理员也可以从控制面板的信息亭模式设置部分的会话启动历史(Session Launch History)表中结束活跃的信息亭模式会话。

信息亭模式会话范围(Kiosk mode session scope)

信息亭模式下模块的权限将被缩小，以限制活跃会话中可查看的内容。因此，在信息亭模式下查看模块时，您能看到的内容可能与在查看或编辑模式下看到的内容不同。

在信息亭模式会话范围内可见的内容将显示在启动信息亭会话(Launch kiosk session)模态框的范围内内容(Content in scope)部分。请注意，来自嵌入Workshop模块的嵌套实体将自动包含在内，并在信息亭模式会话中可见。然而，来自其他嵌入Foundry应用程序的嵌套实体不会自动包含在内。

以下两个示例说明了信息亭模式如何缩小实体权限以限制会话中可查看的内容：

• 通过Vertex Graph小部件嵌入的Vertex Graph可能引用了一个在Workshop模块中不直接存在的对象类型。这意味着当启动信息亭模式会话时，该对象类型将不会包含在会话范围内，并且在信息亭模式下不可见。
• 在信息亭模式下，如果模块中某个对象类型上执行搜索关联的函数对应的链接类型不在Workshop模块中，则该函数可能会执行失败。

您可以使用启动信息亭会话(Launch kiosk session)来确定哪些实体在信息亭模式下会存在或缺失。要将缺失的实体包含在信息亭模式会话范围内，您可以在模块中的某处添加对该实体的直接引用。

限制(Limitations)

• 由受限视图数据源支持的对象类型在信息亭模式下不受支持。
• 出于安全考虑，所有嵌入的Slate应用程序均被禁用，因为它们能够回写本体论(Ontology)。
• 在开发OSDK应用程序时，应用程序构建者有责任确保iframe的内容适当管理授权或令牌，以便授权在整个信息亭会话期间保持有效。有关更多信息，请参阅刷新访问令牌(refreshing an access token)。
• 标准的不活动超时对话框在信息亭模式会话中仍然会出现。虽然信息亭会话设计为长期运行，但出于安全原因，它们遵循平台的会话超时策略。