Client configuration

PiCLI can be customized and configured with the settings in the piclient.conf configuration file or by using an environmental variable. The piclient.conf configuration file configures default and model command table formats, workspace file setup automation, and various other configuration options. 

Client configuration overview

The behavior of PiCLI can be customized using the piclient.conf configuration file. The default location is ~/.methodics/piclient.conf, but may be placed in another directory by using the 'MDX_CONFIG_DIR' variable.

If a configuration item is set in multiple locations, the following precedence is used, where each subsequent level overrides the one before it:

1. Program default settings

2. piclient.conf

3. Environmental options

4. CLI args

The configuration file is segmented into several sections, each is described in the following tables.

General section

Configuring PiServer

Setting ASCII mode

Configuring time reporting format

Configuring the Workspace Manager

Configuring the maximum number of results

BuildIC section

Configuring BuildIC server

PWM section

The details of the PWM section are described on the Workspace configuration page.

Configuring unmanaged files save location

Configuring PiClient compression

Configuring PiClient p4 sync Batch Size

Configuring whether to set access in the workspace

PICACHE (IPLM Cache) section

Configuring IPLM Cache server

Configuring IPLM Cache compression

Setting	Example	Environment Variable	Description
picache_compression	picache_compression = True	MDX_PICACHE_COMPRESSION	Controls client-side filelist compression to IPLM Cache for older Pi Client versions. From version 2.35.1 and later, we use the IPLM Cache 1.5 (and later) compression setting and this client compression setting is ignored.  For IPLM Cache version 1.4.1 and older, Pi Client's compression setting will be used. Server-side compression is enabled by setting the IPLM Cache configuration file's 'compression' setting, in the file's [main] section, to True.

Configuring STATIC_HEAD

Setting	Example	Default	Environment Variable	Description
static_head	static_head = true	False	MDX_PICACHE_STATIC_HEAD	IPVs loaded @HEAD in refer mode are loaded in static mode. The IPV directory contains the files corresponding to @HEAD at the time the IPV is loaded into the cache. The directory is named according to the revision number that corresponds to the @HEAD files loaded. Subsequent @HEAD refer mode loads and updates load into new directories without updating previously loaded @HEAD directories, which remain static.

Configuring PiCLI wait time for IPLM Cache populate

Configuring IPLM Cache to mimic BuildIC directory structure

Perforce specific section

Configuring Perforce behavior

Models

Model sections work exactly like the Reports section described above. The name of the section provides the name of the model. This will create a model named foo that will redefine the view for pi ip list only. The other commands will use the base settings defined in the [Reports] section:

[Reports_foo]
ip = name --sort --nowrap
    description --rtrim --width 20
    resources --multiline
    private_resources --multiline --optional

Examples

[Reports_uuid]
workspace = top_ipv --sort --nowrap --title "TOP IPV"     creator  --title "CREATED BY"     path --nowrap
     uuid --title "UUID"[Reports_updated]
workspace = top_ipv --title "TOP IPV" --sort --nowrap
            last_updater --title "UPDATED BY"            last_update_timestamp --title "UPDATED ON"            path --nowrap

[Reports_copies]
ip = name --sort --nowrap
     creator --title "CREATED BY"     creation_timestamp --title "CREATED ON"     version_message --title "VERSION MESSAGE"     source --title "COPIED FROM"[Reports_power]
ip = name --sort --nowrap
     dm_type --title DM
     aliases
     creator --title "CREATED BY"     prop_power --title "POWER" --optional
     prop_target_power --title "TARGET POWER" --optional
     version_message --title "VERSION MESSAGE"[Reports_p4client]
workspace = top_ipv --sort --nowrap --title "TOP IPV"     creator --title "CREATED BY"     path --nowrap
     p4_client --nowrap --title "P4 CLIENT"[Reports_wman]
workspace = top_ipv --sort --nowrap --title "TOP IPV"     creator --title "CREATED BY"     path --nowrap
     workspace_manager --nowrap --title "WMAN"[Reports_license]
ip = name --sort --nowrap
	dm_type --title DM
	prop_process_name --title "PROCESS" --optional
	prop_process_node --title "NODE" --optional
	prop_external_ip --title "EXT" --optional
	prop_license_agreement --title "LICENSE" --optional
	prop_owner --title "OWNER" --optional
        prop_internal_ipid --title "ID" --optional
	aliases