Embedded Help system properties
Embedded help is active by default on your instance. The administrator can change system properties to modify how the instance interacts with embedded help.
The administrator navigates to Embedded Help > Properties to change these properties.
| Name | Description |
|---|---|
| com.glide.embedded\_help.auto\_close | Auto-closes the help pane when the user clicks Start a Tour or Back To Guided Setup.- Type: true \| false - Default value: true |
| com.glide.embedded\_help.cdn\_timeout | Duration in milliseconds at which a content pull from the Content Delivery Network \(CDN\) is timed out.- Type: integer - Default value: 2000 |
| com.glide.embedded\_help.enabled | Enables the embedded help plugin for activation.- Type: true \| false - Default value: true |
| com.glide.embedded\_help.enable\_video | Enables users to see embedded videos in help content. The administrator can embed video and a description, but if this property is false, the video and description are hidden in the help pane.- Type: true \| false - Default value: true Note: When you embed video content, enclose the video embed code and description inside a |
| com.glide.embedded\_help.sync | Enables the instance to look in the CDN for updated content when a user accesses a UI page. The instance checks the Last sync date in the topic against the specified frequency to determine whether to look in the CDN for updated content. - Type: true \| false - Default value: true If the property is disabled (false), the embedded help content is never synced with CDN topic updates. |
| com.glide.embedded\_help.sync\_frequency | Specifies how many days must pass from the Last sync date in the topic for the embedded help process to look for updated content in the CDN.- Type: integer - Default value: 15 |
| com.glide.embedded\_help.sync\_self\_hosted | Specifies whether a self-hosted instance syncs content with the CDN.- Type: true \| false - Default value: false |
| com.glide.embedded\_help.url | Lists the location from where embedded help is dynamically retrieved.- Type: string - Default value: varies |
| com.glide.embedded\_help.version | Specifies the instance version for which help is displayed.- Type: string - Default value: Jakarta If blank, displays the help for the version the instance is currently running. |
The following system property is available by navigating to the [sys_properties] table.
| Name | Description |
|---|---|
| com.glide.embedded\_help.guided\_setup.persist\_actions | Enables Guided Setup actions in the embedded help panel that are based on states to display on all pages. An example is the Mark as Complete action. The default behavior (false) is to only show actions on the initial Guided Setup page.- Type: true \| false - Default value: false |
Parent Topic:Embedded Help reference