View Project Information

By default, projects built using the Crestron Template Project contain an information icon in the header bar (or elsewhere in the project if configured this way) that can be selected to display a Project Info dialog box.

NOTE: The Project Info dialog box can be shown or hidden from the project using the project-config.json file. For more information, refer to Modify the Info Pop-Up.

The Project Info dialog box can be used to view various information about the project, including its packaged components, HTML5 Web XPanel status, and diagnostics for project testing. Select the x button at the top right of the dialog box to close it.

Each section of the Project Info dialog box is described in the sections that follow.

Version

Select the Version tab to view information about the packaged components within the project.

The following information is provided in table form:

  • Package: The packaged component used within the Crestron Template Project (such as ch5-crcomlib).
  • Version: The build version of the packaged component.

Web XPanel

Select the WebXPanel tab to view the status of the HTML5 Web XPanel functionality for the project (if applicable).

NOTE: For more information on HTML5 Web XPanel deployments, refer to HTML5 Web XPanel Deployment.

The following information is provided:

  • Connection: Displays status information about the HTML5 Web XPanel connection.
    • Status: Indicates whether the HTML5 Web XPanel connection to the control system is currently active.
    • CS: Indicates the IP address and port of the connected control system.
    • IPID: Indicate the IP ID used to connect to the control system (in hexadecimal notation).
    • Room ID: For Crestron Virtual Control connections, indicates the room ID used to connect to the Crestron Virtual Control room.

Diagnostics

Select the Diagnostics tab to view various diagnostics for the project. These diagnostics reports are helpful when testing and debugging the project for performance‑related issues.

The following information is provided:

  • Total CH5 Tags/Attrs: Indicates the total number of CH5 tags and attributes within the project. The CH5 tags and attributes for each page are calculated and added to the totalCh5Component variable.
  • Current CH5 Tags/Attrs: Indicates the number of CH5 tags and attributes within the current page. The CH5 tags and attributes for the current page and the cachePage (if true) count of CH5 tags and attributes are calculated.
  • Total DOM Nodes: Indicates the total DOM node count of visited pages. The DOM node count on the navigated page is calculated and added to the total DOM count.
  • Page Count: Indicates the total number of pages in the project. The page count is calculated using the translate module.
  • Total Signals: The total number of signals in the project. All signals for the project are calculated (for example, active_state_class_0, ch5‑import‑htmlsnippet:page1‑import‑page).
  • Total Subscriptions: The total number of signals with subscriptions in the project. Signals are iterated to check whether the signal has a subscription or not (for example, if a user subscribes to active_state_class_0 two times, then the total subscription count will be 2.
  • Add Log: Select this button to view all diagnostic information in the console.

Additionally, a table is provided that lists the following diagnostic information for each page within the project:

  • Name: The name of the page within the project.
  • CH5 Tags/Attrs: The number of CH5 tags and attributes within the associated page.
  • Preload: Indicates whether page preload is true or false for the associated page. If true, the page loads at project load time. When a user visits and then leaves the page, the preloaded page is removed from the DOM. A number is shown in the header column that represents the total count of pages that use preload.
  • Cached: Indicates whether page caching is true or false for the associated page. If true, the page is cached when the user navigates from it to another page, and the current page content is not removed from the DOM. A number is shown in the header column that represents the total count of pages that use caching.
  • Nodes: Indicates the total DOM nodes present within each page.