IPLM Web configuration

PIWEB_USER

root

The user that runs IPLM Web server process. Default value is 'root'. This user must have sufficient privileges to run IPLM Web service.

PIWEB_PORT

80

Port for running IPLM Web service. Default value is port 80. Change this if port 80 is not usable in your local environment.

PIWEB_LOG_LEVEL

warn

Log level for IPLM Web service. Default value is warn, additional option is error.

Set to the IP address or Hostname on which the IPLM Web server is running. This variable is used internally by the application. When IPLM Web is configured behind a proxy, the value should still be the IP address or Hostname on which the IPLM Web Server is running, not the proxy.

Set these values to remove the need for users to enter credentials when viewing Help topics.

Specify a URL segment that consists of:

• IPLM’s Help system host name (i.e. help.perforce.com),

• Prefix the user id and password assigned to you that enables access to IPLM Help.

Example:

PIWEB_HELP_URI=https://<userid:password@>help.perforce.com

Note:

Setting this does expose the userid/password to any IPLM user in your environment.

Defines a list of external javascript libraries allowed to be referenced to in the script tag, or a list of regular expressions that match the allowed URLs. The match must be exact or matching with the given regular expression.

It is recommended to add only references to the generic latest LTS of a library, rather than referencing a specific version.

Consult your security team for approval before implementing this configuration.

Set to the machine name that the IPLM PiForce server is running on with the IPLM PiForce port, such as <piforceserver>:<piforceport>.

The IPLM PiForce port is set in piforce.yml under server: applicationConnectors: port:

# HTTP server
server:
    applicationConnectors:
        - type: http
          port: 8098

URL for Pi API Docs.

The host portion should be set to a routable IP/FQDN for IPLM Server installation. The docs are available on port 8080 under URI /public-api-doc.html. The application includes a link to Public API documentation, which is provided by this setting. Setting has syntax: http://<ip_or_host>:8080/public-api-doc.html

none

This is an HTML snippet for a custom header link to local hosted documentation:

HEADER=<a href="#/home" target="_self" class="navbar-brand ml-4"><img title="Go to Home" src="/media/img/logo-helix-iplm-black.png" alt="Helix IPLM v2023.4"></a> <a href=https://www.perforce.com/products/methodics-iplm target="_blank">IPLM Documentation</a>

'fqn',
'ip_created_date',
'ipv_created_date',
'ip_author',
'ipv_author',
'ip_description',
'ip_dm_type',
'ip_lines',
'ip_lib',
'ipv_alias',
'labels',
'proj_prop',

Specify list of searchable fields in Advanced search interface. Unspecified fields are hidden from selectable fields menu.

Possible values:

fqn,        
ip_created_date,        
ipv_created_date,        
ip_author,        
ipv_author,        
ip_description,        
ip_dm_type,        
ip_lines,        
ip_lib,        
ipv_alias,        
labels,        
proj_prop,
<custom property name>

Specify list of featured searchable fields in Advanced search interface. Featured fields are displayed more prominently above the Select fields menu. Possible values are same as QUERY_BUILDER_FIELDS

enhanced or <blank>: The IP catalog search will use the global search engine. See more at IP catalog global search and syntax.

query: Use the legacy query search method. In query mode, you can also limit the columns that are searched by modifying IP_CATALOG_SEARCH_COLUMNS.

To use these settings, IP_CATALOG_SEARCH_ENGINE must be set to query. Specify the columns that should be searched by the search field available from the IP catalog. If not set (default) the currently displayed columns will be searched. If set, only the specified columns will be searched, whether they are currently displayed or hidden.

Limiting the columns that are searched can provide more consistent search results and search performance.

Built in fields can be specified, as well as defined property names.

example: IP_CATALOG_SEARCH_COLUMNS=name,library,dm_type,description, property1, property2

DEFAULT_IP_TAB

Specify a default view (tab) for IP page. Available options: appTabDetails, appTabHierarchyAndContents, appTabDashboard, appTabUsage, appTabPlanningBom, appTabParents, appTabLineGraph

The DEFAULT_IPV_TAB setting in the IPLM Web configuration file has been removed. Use the DEFAULT_IP_TAB setting when specifying a default view for the IP page.

The ADDITIONAL_HEAD_HTML environment variable allows you to inject custom HTML code into the <head> section of your web application. This can be useful for including external stylesheets, meta tags, analytics scripts, or other resources that need to be loaded early in the page lifecycle.

example: ADDITIONAL_HEAD_HTML="<link rel='stylesheet' href='https://example.com/styles.css'>"

The ADDITIONAL_BODY_HTML environment variable allows you to inject custom HTML code at the end of the <body> section of your web application. This is typically used for including JavaScript files, analytics tracking scripts, or other elements that should load after the main content of the page.

example: ADDITIONAL_BODY_HTML="<script src='https://example.com/script.js'></script>"

By default, IPLM Web has enabled secure cookies in HTTP requests and responses so cookies are only transmitted over a secure HTTPS connection.

Set the URL of the authentication service that provides Single Sign-On (SSO) capability from IPLM Web.

The ENABLE_IP_TITLE_DASHBOARD setting enables you to display or hide the IP page custom title.

Requirements:

• Set this value to true

• One or more widgets are attached to the IP and/or its IPVs with the widget's dashboard property set to ip-title

Check out Configure custom title for IP page for more information.