File viewing troubleshooting tips for non-Hexagon formats (retired) - SmartPlant Foundation - SmartPlant Foundation 2020 - Help - Hexagon

SmartPlant Foundation and Web Client Modified and Retired Functionality

Language
English (United States)
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)

The following applies if you are using a version of the software before Update 33 and SmartPlant Markup Plus Server 2019 SP 1 or earlier. For the latest information, see File viewing problems.

This topic contains general troubleshooting information.

Verify that SmartPlant Markup Plus Server is installed correctly

Verify the following on the SmartPlant Markup Plus server:

  • The Apache Tomcat service is started.

  • The Apache Tomcat home page opens when navigating to https://localhost:8443 or http://localhost:8080 using a browser.

  • The BravaLicense.war and BravaServer.war files are delivered to the [installation location]\Apache Software Foundation\Tomcat [version]\webapps folder.

  • The BravaLicense.war file is using the IGCKey.lic file delivered to the [installation location]\SmartPlant\Markup\Brava! Enterprise\Brava! License folder. Do the following:

    • Navigate to https://localhost:8443/BravaLicense/License or http://localhost:8080/BravaLicense/License using a browser.

      You will be asked to download a JSON file.

    • Save the JSON file and open the file using Notepad.

      The contents of the JSON file should match the contents of the IGCKey.lic file delivered to the [installation location]\SmartPlant\Markup\Brava! Enterprise\Brava! License folder.

Fixing SmartPlant Markup Plus Server installation issues

Do the following if the BravaLicense.war and BravaServer.war files are not delivered to the [installation location]\Apache Software Foundation\Tomcat [version]\webapps folder.

If using versions prior to SmartPlant Markup Plus 10.0.1:

  1. Log on to the SmartPlant Markup Plus server as an administrator.

  2. Navigate to the [installation location]\SmartPlant\Markup\Brava! Enterprise\ServerWar folder.

  3. Zip all of the contents and rename the zip file BravaServer.war.

  4. Copy the BravaServer.war file to the [installation location]\Apache Software Foundation\Tomcat [version]\webapps folder.

  5. Navigate to the [installation location]\SmartPlant\Markup\Brava! Enterprise\Brava! License\LicenseWar folder.

  6. Zip all of the contents and rename the zip file BravaLicense.war.

  7. Copy the BravaLicense.war file to the [installation location]\Apache Software Foundation\Tomcat [version]\webapps folder.

  8. Restart the Apache Tomcat service, deploying the .war files.

If using SmartPlant Markup Plus 10.0.1 and later versions:

  1. Log on to the SmartPlant Markup Plus server as an administrator.

  2. Search for the BravaLicense.war and BravaServer.war files in the delivered SmartPlant Markup Plus installation folder.

  3. Copy the .war files to the [installation location]\Apache Software Foundation\Tomcat [version]\webapps folder.

  4. Restart the Apache Tomcat service, deploying the .war files.

Log files

Several of the software components provide log files that include pertinent information about the software. You can locate the various log files by searching for *.log on your computer. You can open log files and view their contents using a text editor such as Notepad.

You can collect logs from:

  • Brava! Server, delivered to: [installation location]\SmartPlant\Markup\Brava! Enterprise\Brava! Server\log

  • Brava! License, delivered to: [installation location]\SmartPlant\Markup\Brava! Enterprise\Brava! License\log

  • Apache Tomcat, delivered to: [installation location]\Apache Software Foundation\Tomcat [version]\logs

  • Job Processor Status section of the SmartPlant Markup Plus Server Status page (click Start > All Programs > Intergraph SmartPlant Markup Plus > Markup Server Status)

  • The heartbeat.txt file is located in the dlcache folder. You can open the server.properties file on SmartPlant Markup Plus server and view the full folder path under the local.displaylist.cache.root property.

    If you are using SmartPlant Markup Plus 2019 Service Pack 1 or later, the heartbeat.txt file is disabled by default. To enable, please refer to Enable log collection using heartbeat.txt files.

Logging errors

After completing the following logging steps, reproduce the problem and provide the Brava! Server log files to customer support.

Return levels back to "error" after logging is complete. Trace level logging is noisy.

Apache Tomcat logging

  1. Log on to the SmartPlant Markup Plus server as an administrator.

  2. Open the logback.xml file delivered to the [installation location]\Apache Software Foundation\Tomcat [version]\webapps\BravaServer\WEB-INF\classes folder.

  3. Update the following:

    <logger name="com.infograph.httpserver.PublishRequestQueueServlet" level="error" />

    <!--

    <logger name="com.igc" level="error" />

    <logger name="com.infograph.httpserver" level="error" />

    <logger name="org.springframework.beans" level="error"/>

    <logger name="org.springframework.jdbc" level="error"/>

    <logger name="org.springframework" level="trace" /> -->

    to:

    <logger name="com.infograph.httpserver.PublishRequestQueueServlet" level="error" />

    <logger name="com.igc" level="trace" />

    <logger name="com.infograph.httpserver" level="trace" />

    <!--

    <logger name="org.springframework.beans" level="error"/>

    <logger name="org.springframework.jdbc" level="error"/>

    <logger name="org.springframework" level="trace" /> -->

  4. Click Start > Administrative Tools > Services.

  5. Restart the Apache Tomcat service.

Additional Apache Tomcat logging

  1. Log on to the SmartPlant Markup Plus server as an administrator.

  2. Open the server.xml file delivered to the [installation location]\Apache Software Foundation\Tomcat [version]\webapps\BravaServer\WEB-INF\classes folder.

  3. Uncomment the following by removing the commenting brackets: (<!-- and -->)

    <!--<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"

    prefix="localhost_access_log" suffix=".txt"

    pattern="%h %l %u %t &quot;%r&quot; %s %b" />-->

  4. Click Start > Administrative Tools > Services.

  5. Restart the Apache Tomcat service.

Brava! License logging

  1. Log on to the SmartPlant Markup Plus server as an administrator.

  2. Open the logback.xml file delivered to the [installation location]\Apache Software Foundation\Tomcat [version]\webapps\BravaServer\WEB-INF\classes folder.

  3. Update the following:

    <root level="error">

    <appender-ref ref="rolling" />

    <appender-ref ref="stdout" />

    </root>

    to:

    <root level="trace">

    <appender-ref ref="rolling" />

    <appender-ref ref="stdout" />

    </root>

  4. Click Start > Administrative Tools > Services.

  5. Restart the Apache Tomcat service.

Debug the browser

You can run your browser in debug mode to view errors. Export the logs from your browser to a ZIP file. You can provide these files to customer support for troubleshooting. Refer to your browser's help file for debugging information.

Zip pertinent files

Zip the files pertaining to the most recent failed attempt in the dlcache folder on the SmartPlant Markup Plus server. You can provide these files to customer support for troubleshooting.

Clear the dlcache folder to regenerate cached non-Hexagon files

You must clear the dlcache folder to regenerate cached non-Hexagon files. This prevents any failed cached copies from being displayed.

If you are using Update 14 or later, an administrator can click Clear Display Cache on the Actions menu of the file or document in the Web Client. If you are using a version prior to Update 14, an administrator must delete the files in the dlcache folder on the Brava! Enterprise Server, typically installed on the SmartPlant Markup Plus server. The dlcache folder location is set by the local.displaylist.cache.root property in the server.properties file delivered to the Brava! Server folder.