Kahua has incorporated several ‘out of the box’ videos to assist users with common activities in applications. These videos are accessed by right clicking on the application when open on the left toolbar, and clicking Videos and Documentation. However, to configure and select which videos or guides are visible to users in this space, Kahua allows companies to post custom collateral for their users to refer to within each application. These videos and PDFs can be tied to an application in the Configuration app, within the Videos and Documentation tab of the application’s detail pane.
There are several requirements that Domain Administrator’s should be aware of prior to uploading a video or PDF to an application:
- Videos and Documentation may be uploaded at the ‘root’ of a domain, or at a particular partition. Like other configuration features, Videos and Documentation follows the inheritance model, meaning uploading videos and documentation at a partition will mean that this collateral is also now in turn visible at all partitions and projects deeper in your project hierarchy (unless overridden).
- Kahua’s default videos may be ‘disabled’ if your company has custom collateral they wish for user’s to reference in lieu of the standard videos. See below for instructions on disabling a video.
- To upload a video, the video can be hosted in Wistia (Wistia.com), YouTube, or Vimeo – Kahua references videos by the ‘ID’ of a video. To upload a PDF guide, the PDF must be publicly hosted (have a public URL associated with it).
To Add (or Remove) a Video or Document to an Application:
- Open the Configuration detail pane for the application that you desire to add (or remove) documentation from. Click on the Videos and Documentation tab.
- Once in the tab, toggle to Override.
- If there are any videos pre-uploaded (Kahua videos) or videos you previously added to this application, they will be listed under the Videos section, and any PDFs previously added will display under the Documents section.
- To disable a video from appearing, uncheck the box under ‘Enabled’ next to the video or Document you wish to remove. Removing this checkmark (and saving) will remove the video or document from that partition and any partitions below – assuming no partitions are set to override.
- To add a Video or Document, click Add to the right of the header for each section. Notice a form appears at the bottom of the pane. The fields should be populated as below:
Videos fields:
Name - The name of the content, this is not exposed in the panel
Label - The value that appears for the title of the documentation in the panel
Description - The descriptive value of the content that appears under the Label in the panel
Source - Allows the user to select whether the video is hosted in Wistia, YouTube, or Vimeo
ID - This is the ID of the video; for the best results do not include the entire URL of the video.
Documents fields:
Name - The name of the content, this is not exposed in the panel
Label - The value that appears for the title of the documentation in the panel
Description - The descriptive value of the content that appears under the Label in the panel
PDF URL - The full URL of the PDF to be displayed. PDFs must be hosted on a publicly available webpage. PDFs that reside in Kahua are not permitted to be used as a help document due to permissions and access controls that are enforced.
