Configuring 3DDashboard Integration

This section describes how to ensure the good integration of Issue Intelligence within the 3DDashboard.

This task shows you how to:

Configure the Reverse Proxy

The 3DDashboard needs to be able to communicate with the Issue Intelligence back-end. As this involves secured and cross-domain communications, we recommend using a reverse proxy to address these requirements and, in addition, mask the actual location of Issue Intelligence to end users.

The reverse proxy must be accessible by the 3DDashboard through an HTTPS endpoint. This means the 3DDashboard must trust the SSL certificate used by the reverse proxy.

For complete interoperability, Issue Intelligence and the 3DDashboard must be both on the same virtual host.

Before you begin:

This procedure shows an example with the Apache httpd reverse proxy and uses the following variables:

  • ISSUE_INTERNAL_URL : the Issue Intelligence URL, including the port and /issue . For example, http://issue.my-company.com:10000/issue

  • ISSUE_EXTERNAL_URL : the Issue Intelligence URL visible externally, including port, as defined by the reverse proxy configuration. For example, https://experience.my-domain.com:443/issue

Note: When Issue Intelligence is configured to be accessible from the 3DEXPERIENCE, you can still access stand-alone Issue Intelligence in a browser at: <ISSUE_EXTERNAL_URL> /page/index (make sure to include /index in the path).
  1. Open the reverse proxy configuration located at, for example, /usr/local/reverseproxy/conf/httpd.conf, accessible by root.
  2. Add the lines shown below to the <VirtualHost> tag that also contains the 3DDashboard reverse proxy configuration. Make sure to replace <ISSUE_INTERNAL_URL> with the actual value. 

    # Issue Intelligence
  ProxyPass        /issue <ISSUE_INTERNAL_URL>
  ProxyPassReverse /issue <ISSUE_INTERNAL_URL>

    Example of the full virtual host configuration for a Windows installation (the 3DDashboard information comes from Install > 3DEXPERIENCE Platform > Installing 3DEXPERIENCE Platform Services for the First Time > Installing Services One-by-One > 3DDashboard > Configuring the Reverse Proxy):
    Listen 443 
<VirtualHost *:443>
  SSLEngine on
  ProxyPreserveHost Off
  ServerAlias myserver

  # 3DDashboard:
  Include <3DDashboardInstallPath>\win_b64\templates\3DDashboard_httpd_fragment.conf

  # Issue Intelligence
  ProxyPass        /issue <ISSUE_INTERNAL_URL>
  ProxyPassReverse /issue <ISSUE_INTERNAL_URL>

  # Other services that may have been configured

  RequestHeader set x-forwarded-port "443"
</VirtualHost>
  3. Restart the reverse proxy server (still root), using the command: /usr/local/reverseproxy/bin/httpd -k restart

Register Issue Intelligence Service

The 3DDashboard relies on the "Compass Platform Services" API to retrieve the Issue Intelligence backend URL. As such, the URL where Issue Intelligence has been installed must be defined in the 3DCompass configuration. The 3DCompass uses an environment variable set in 3DSpace.

Context:

This procedure uses the following variable:

  • ISSUE_EXTERNAL_URL : the Issue Intelligence URL visible externally, including port, as defined by the reverse proxy configuration. For example, https://experience.my-domain.com:443/issue

  1. Open the 3DSpace root installation directory (for example, /home/data/RTV/<DIR>/server/)
  2. Move to the /scripts directory.
  3. Edit all .sh files with names beginning with mxEnv. For example, edit mxEnvCAS.sh, mxEnvNotVerbose.sh and mxEnvVerbose.sh
  4. Add the following lines, replacing <ISSUE_EXTERNAL_URL> with actual value:
    1. IssueIntelligence_URL=<ISSUE_EXTERNAL_URL>
    2. export IssueIntelligence_URL
  5. Save files and restart the application server.