Trigger script variables

%action%

Either null or a string reflecting an action taken to a changelist or job.

For example,"pending change 123 added" or "submitted change 124 deleted" are possible %action% values on change forms, and "job000123 created" or "job000123 edited" are possible %action% values for job forms.

%argc%

Command argument count.

%args%

Command argument string.

%argsQuoted%

Command argument string that contains the command arguments as a percent-encoded comma-separated list.

%changelist%, %change%

The number of the changelist being submitted. The abbreviated form %change% is equivalent to %changelist%.

A change-submit trigger is passed the pending changelist number; a change-commit trigger receives the committed changelist number.

A shelve-commit or shelve-delete trigger receives the changelist number of the shelf.

%changeroot%

The root path of files submitted.

%client%

Triggering user’s client workspace name.

%clientcwd%

Client’s current working directory.

%clienthost%

Hostname of the user’s workstation (even if connected through a proxy, broker, replica, or an edge server.)

%clientip%

The IP address of the user’s workstation (even if connected through a proxy, broker, replica, or an edge server.)

%clientprog%

The name of the user’s client application. For example, P4V, P4Win

%clientversion%

The version of the user’s client application.

%command%

Command name.

%file%

Path of archive file based on depot’s Map: field. If the Map: field is relative to P4ROOT, the %file% is a server-side path relative to P4ROOT. If the Map: field is an absolute path, the %file% is an absolute server-side path.

%firstPushedChange%

First new changelist number.

See Additional triggers for push and fetch commands.

%formfile%

Path to temporary form specification file. To modify the form from an in or out trigger, overwrite this file. The file is read-only for triggers of type save and delete.

%formname%

Name of form (for instance, a branch name or a changelist number).

%formtype%

Type of form (for instance, branch, change, and so on).

%groups%

List of groups to which the user belongs, space-separated.

%intermediateService%

A broker or proxy is present.

%jobs%

A string of job numbers, expanded to one argument for each job number specified on a p4 fix command or for each job number added to (or removed from) the Jobs: field in a p4 submit, or p4 change form.

%lastPushedChange%

Last new changelist number.

See Additional triggers for push and fetch commands.

%maxErrorSeverity%

One of empty, error, or warning.

%maxErrorText%

Error number and text.

%maxLockTime%

A user-specified value that specifies the number of milliseconds for the longest permissible database lock. If this variable is set, it means the user has overridden the group setting for this value.

%maxResults%

A user-specified value that specifies the amount of data buffered during command execution. If this variable is set, it means the user has overridden the group setting for this value.

%maxScanRows%

A user-specified value that specifies the maximum number of rows scanned in a single operation. If this variable is set, it means the user has overridden the group setting for this value.

%oldchangelist%

If a changelist is renumbered on submit, this variable contains the old changelist number.

%op%

Operation: read, write, or delete.

%peerhost%

If the command was sent through a proxy, broker, replica, or edge server, the hostname of the proxy, broker, replica, or edge server. (If the command was sent directly, %peerhost% matches %clienthost%)

%peerip%

If the command was sent through a proxy, broker, replica, or edge server, the IP address of the proxy, broker, replica, or edge server. (If the command was sent directly, %peerip% matches %clientip%)

%P4PORT%

The host port to which the client connects. If the client connects to the server through an intermediary, this will hold the port number of the intermediary. If there’s no intermediary, this will hold the same value as the %serverAddress% variable.

%quote%

A double quote character.

The repo, which has .git as a suffix, but otherwise is identical to %repoName%.

The name of the repo. See Triggering with depots of type graph.

%rev%

Revision of archive file

%serverAddress%

The IP address and port of the Helix Core server, passable only in the context of a client-side script specified by P4LOGINSSO.

%serverhost%

Hostname of the Helix Core server.

%serverid%

The value of the Helix Core server’s server.id. See p4 serverid in the Helix Core P4 Command Reference for details.

%serverip%

The IP address of the server.

%servername%

The value of the Helix Core server’s P4NAME.

%serverport%

The transport, IP address and port of the Helix Core server, in the format prefix:ip_address:port.

prefix can be one of ssl, tcp6, or ssl6. This means that the command p4 -p %serverport% can be used to connect to the server no matter which type of connection the server uses.

%serverroot%

The P4ROOT directory of the Helix Core server.

%serverservices%

A string specifying the role of the server. One of the following:

• standard
• replica
• broker
• proxy
• commit-server
• edge-server
• forwarding-replica
• build-server
• P4AUTH
• P4CHANGE

%serverVersion%

Version string for the server that terminated if the command exited early. Reason for termination is given in %termReason%.

%specdef%

Expanded to the spec string of the form in question.

%submitserverid%

If this is not a distributed installation, %submitserverid% is always empty.

In a distributed installation, for any change trigger:

• if the submit was run on the commit server, %submitserverid% equals %serverid%.
• if the submit was run on the edge server, %submitserverid% does not equal %serverid%. In this case, %submitserverid% holds the edge server’s server id.

If there is a forwarding replica between the commit server and the edge server, then %submitserverid% actually holds the forwarding replica’s server id.

See p4 serverid in the Helix Core P4 Command Reference.

%terminated%

The value of 0 indicates that the command completed. A value of 1 indicates that the command did not complete.

%termReason%

The reason for early termination. This might be one of the following:

• 'p4 monitor terminate'
• client disconnect
• maxScanRows
• maxLockTime
• maxResults

See also %serverVersion%.

%triggerMeta_action%

Command to execute when trigger is fired. Last field of trigger definition. Set only when you run a script from the depot.

%triggerMeta_depotFile%

Third field in trigger definition. Its meaning varies with the trigger type. For a change-submit trigger, it is the path for which the trigger is expected to match. For a form-out trigger, it might be the form type to which the trigger is expected to apply. See the description of the trigger types for more information on the meaning of this field.

%triggerMeta_name%

Trigger name: first field from trigger definition. Set only when you run a script from the depot.

%triggerMeta_trigger%

Trigger type: second field in trigger definition. Set only when you run a script from the depot.