Support - Checking CMiC Versions

This article provides a concise and practical overview of how to check version information across various CMiC platforms and modules. Whether you're working with Enterprise, CMiC Field, CMiC Construct Apps, CMiC BI, or Jasper Reports, this document outlines the steps necessary to retrieve version details efficiently. This is particularly useful for CMiC Support and should be provided on cases when it is applicable.

Enterprise

The About screen, preferably the program specific one, can be used to check version information in Enterprise. If that is not available, the console version of the About screen can be used, as highlighted in the screenshot below.

Screenshot of the About icons available on Enterprise

CMiC Field

The version.jsp of the specific program can be used to check version information in CMiC Field. If that is not available, the version.jsp of the SdMenu can be used instead.

NOTE: The link to the version.txt is available on both.

  1. From the specific program, right click on the screen and select one of the following options depending on your browser:

    • View frame source (Edge/Chrome)

      Screenshot of the View Frame Source option in Edge/Chrome

    • This Frame > View Frame Source (Firefox)

      Screenshot of View Frame Source option in Firefox

  2. From there, note the context-root of the resulting URL:

    Screenshot of the context-root on the URL

  3. Follow the steps below to create the URL for the version.jsp:

    1. Take the URL when accessing CMiC Field.

      URL of CMiC Field

    2. Remove all the text after the Base URL and the environment version:

      URL with text removed

    3. Add the context-root along with "/version.jsp" to the end of the URL, as shown in the screenshot below, then hit enter:

      Sample of new URL for the version.jsp

      Screenshot of the Version Information screen

  4. If the program specific version is not available, you may gather this information for the SdMenu instead. Begin by going to the Application Selector screen:

    Screenshot of the Application Selector

  5. Following that, please remove all the text after "SdMenu/":

    Screenshot of the SdMenu URL

  6. Finally, add "version.jsp" to the end of the URL and enter it:

    Screenshot of the version.jsp URL using the SdMenu

    Screenshot of the Version Information screen

Construct Apps

The version information can be accessed from CMiC Construct apps (mobile or web versions) by clicking the Menu icon in the top left corner, click the Settings icon, and then expand the About section.

NOTE: If the About section is not available in any particular Construct application, you may also retrieve the version information by using the following URL structure:

https://{CMiC domain}/{CMiC server}/{Mobile app}/version.json

For example, you can find the version of Construct PM for NOVA PROD using the following URL:

https://nova.cmiccloud.com/cmicprod/construct-pm/version.json

Screenshot of the version.json containing version information

Screenshot of the Menu icon and Settings icon

Screenshot of the About section

If you are working on a CMiC Mobile App, please also check the OS version of your device. For further details, see:

CMiC BI

To check the CMiC BI version information, navigate to either Dashboard Builder or Query Builder and select File > About from the toolbar.

Screenshot of the About option under the File drop-down menu

Screenshot of the version information

Jasper (PaaS Customers Only)

This is only obtainable for PaaS customers. Enter the Jasper Repository and select the 'About JasperReports Server' link at the bottom left corner of the page.

Screenshot of the About JasperReports Server information pop-up window

CMiC APIs

Each CMiC endpoint rolls up into a container. The containers mimic CMiC product applications. The following describes how to look up version information on file by resource container.

To validate the container version installed on the CMiC API Server instance, append the endpoint name with "/version". In the following example, we want to check the version for this URL: https://{add CMiC domain}/{add CMiC server}/hcm-rest-api/rest/1/pyemployee.

In the example above the container is represented by hcm-rest-api/rest/1 and the endpoint is /pyemployee.

To check the version on this endpoint, remove the "/pyemployee" from the URL and replace it with "/version", then run the GET method to retrieve the version installed.

The URL will be https://{add CMiC domain}/{add CMiC server}/hcm-rest-api/rest/1/version.

The following screenshot is an example for https://nova.cmiccloud.com/cmicprod/hcm-rest-api/rest/1/version.

Example of version information for CMiC API endpoint