Previous Topic: Using the System VariablesNext Topic: clientpath and viewpath Variable Usage


System Variables

CA Harvest SCM includes system variables that you can use in UDP and notify processes. Some of these variables always have a value; the value for other variables depends on the process being executed.

The following table lists each system variable and provides a brief description and the processes in which the variable has a value:

Variable

Description

Has Value in Pre-Linked

Has Value in Post-Linked

clientpath

Location in the destination directory

Check-in, Check-out

Check-in, Check-out

date

Current date

Any process

Any process

project

Current project name

Any process

Any process

broker

Current broker name

Any process

Any process

file

The complete path and file name of a file (or set of files) in the external file system

Check-in for update and release, or update and keep, interactive merge for version name

Check-in for update and release, or update and keep, check-out, interactive merge for version name

itemobjid

The object ID for an item or item path

Delete version

Delete version

nextproject

The next project as defined by a move package process

None

Move package

nextstate

The next state as defined by a demote, move package or promote process

Demote, promote

For a approve process, the values are “approve” or “reject.”

Demote, move package, promote

For a approve process, the values are “approve” or “reject.”

package

Current package name or list of names

Approve, check-in for update and release, or for update and keep, check-out for update and concurrent update, create package, demote, interactive merge, move package, notify, promote, UDP

Approve, check‑in for update and release, or for update and keep, check-out for update and concurrent update, concurrent merge, create package, demote, interactive merge, move package, notify, promote, UDP

password

Plain-text password of the currently logged in CA Harvest SCM user.

Any process

Any process

pathversion

The complete path name (or set of path names) with a version number appended

Delete version

Delete version

state

Current state

Any process

Any process

time

Current time

Any process

Any process

topackage

Target package name

Switch package

Switch package

user

Current user name

Any process

Any process

version

The complete path and item name (or set of item names) with a version number appended when applicable

Check-out, delete version, interactive merge for version number, list version, notify

Check-in, check-out, concurrent merge, delete version, interactive merge for version number, list version, notify

view

Current view name

Any process

Any process

viewpath

Location in the CA Harvest SCM repository

Check-in, Check-ou

Check-in, Check-ou

You can use system variables in a notify process as part of a message or as a parameter in a UDP. The following message illustrates a way to use system variables (enclosed in brackets) in a notify process:

Date: [date]
Time: [time]
Package [package] has been promoted from [state] to [nextstate] by user [user].

More information:

Password System Variable