IPLM PiForce administration

This page shows how to enable PiForce and the settings available in the IPLM PiForce configuration file /etc/mdx/piforce.yml. 

IPLM PiForce features

You can use IPLM PiForce to create a link from a widget to download a file in a specific IPV. This can be useful when you want to link to a specific release of a file, for example when you are referencing Release Notes. See Linking to a file in a specific IPV.

You can also display the file contents of P4 Changelist releases on IPLM Web and allow viewing and downloading of P4 files from the IPLM Web contents page. See IP Versions (Releases).

Setup summary

To configure IPLM PiForce:

1. Configure piforce.yml.

2. Add URI to piweb.conf.

   • PIFORCE_URI=http://myhost:8088

   • where value is the same as the p4:server:uri host and port in piforce.yml

   • protocol must be http:// or https://

3. Verify IPLM PiForce service.

4. Restart IPLM Web service.

P4 server settings

Setting	Default	Description
uri		Use p4java or p4javassl. Set to the Helix Core server address.

P4 client settings

Setting	Default	Description
name	$P4CLIENT or "pi-force"	Enter the base name of the P4 client.

IPLM PiForce logging levels

The logging output becomes more verbose with each option.

• WARN logs warning messages.

• INFO logs info messages.

• DEBUG logs messages helpful for debugging.

piforce.yml example

(venv) root@demo2:~# cat /etc/mdx/piforce.yml
# PiForce configuration
# Complete reference: https://www.dropwizard.io/1.3.11/docs/manual/configuration.html

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

# P4
p4:
    # P4 server
    server:
        # URI (protocol://host:port)
        # Protocols:
        # - p4java
        # - p4javassl
        uri: p4java://p4server.host.example.com:1666
    # P4 client
    client:
        # Base name of the P4 client (default: $P4CLIENT or "pi-force")
        name:

# Logging
logging:
    # Set this to DEBUG to enable complete debug logging (very verbose)
    level: INFO
    loggers:
        # Set this to DEBUG to enable debug logging for the Perforce code
        com.methodics: INFO
    appenders:
      # Type can be one of console, file, or syslog
      - type: file
        currentLogFilename: /var/log/mdx-piforce/piforce.log
        # Whether or not to archive old events in separate files.
        archive: true
        # The number of archived files to keep. Must be greater than or equal to 0. Zero means keeping infinite logs (use with caution)
        archivedFileCount: 5
        archivedLogFilenamePattern: /var/log/mdx-piforce/piforce-%i.log
        maxFileSize: 100 MB