Environment variables

Environment variables are used in scripts and compiled programs to pass values to the executable from the file that caused a trigger to run. See Adding triggers to run executables.

Any variable that does not apply to the event that caused the trigger to run is empty.

You can also use these values as field codes in email templates. Add percent symbols (%) before and after the variable (for example, %SSCM_FILELIST%). See Editing email templates.

File and repository event variables

Variable	Definition
CF_<field code> *	Custom field code
SSCM_BEFOREAFTER	Indicates if trigger fired before or after the event
SSCM_BRANCH	Branch the specified file is in
SSCM_BRANCHTYPE	Type of branch the specified file is in
SSCM_CHANGELISTID	Changelist ID number
SSCM_CHANGELISTNAME	Changelist name
SSCM_CLIENTIP	User’s IP address
SSCM_CLIENTMACHINE	User’s computer name
SSCM_COMMENT *	File event comments
SSCM_DATE	Date the trigger fired
SSCM_ISSUENUMBER *	Helix ALM issue number the file is attached to
SSCM_DESTINATIONREPOSITORY	Repository the file was moved or shared to
SSCM_EVENT	Event that caused the trigger to fire
SSCM_EXTERNALATTACHMENTCONNECTION	Issue tracking tool connection name
SSCM_EXTERNALATTACHMENTID	Issue ID the file is attached to
SSCM_EXTERNALATTACHMENTPROVIDER	Issue tracking tool name
SSCM_FILE *	Filename
SSCM_FILELINK *	File hyperlink in sscm:// format
SSCM_FILELIST	List of files for the event
SSCM_FILEVERSION *	Post-event file version
SSCM_LABEL *	File label
SSCM_LOCALFILE *	Full path of the local file (used with check in or add events only)
SSCM_MAINLINE	Mainline branch the file is in
SSCM_NUMFILES	Number of affected files
SSCM_OLDFILENAME *	Original filename; used with rename event
SSCM_PERMREMOVE *	File was permanently removed (yes/no)
SSCM_REPOSITORY *	Full repository path for the file
SSCM_REQUIREMENTNUMBER *	Helix ALM requirement number the file is attached to
SSCM_SHAREREPOSITORY	Source repository the share was created from
SSCM_SOURCEBRANCH	Source branch used for add, promote, rebase, and duplicate events
SSCM_SOURCEREPOSITORY	Repository the file was moved from
SSCM_TESTCASENUMBER *	Helix ALM test case number the file is attached to
SSCM_TIME	Time the trigger fired
SSCM_TRIGGERDESC	Trigger description
SSCM_USER	User that caused the event to occur

Code review event variables

Variable	Definition
CF_<field code> *	Custom field code
SSCM_AUTHORLIST	Code review author
SSCM_AWAITINGREVIEWBY *	Reviewers who still need to review the code review file
SSCM_BEFOREAFTER	Indicates if trigger fired before or after the event
SSCM_BRANCH *	Branch the specified file is in
SSCM_CLIENTIP	User’s IP address
SSCM_CLIENTMACHINE	User’s computer name
SSCM_CODEREVIEWLINK*	Code review hyperlink in sscm:// format
SSCM_DATE	Date the trigger fired
SSCM_DUEDATE	Due date for the code review
SSCM_EVENT	Event that caused the trigger to fire
SSCM_FILE *	Filename
SSCM_FILELINK *	File hyperlink in sscm:// format
SSCM_FILELIST	List of files for the event
SSCM_MAINLINE	Mainline branch the file is in
SSCM_NOTES	Code review notes
SSCM_REPOSITORY *	Full repository path for the file
SSCM_REVIEWERLIST	Code review reviewers
SSCM_REVIEWFILESTATUS *	Code review file status
SSCM_REVIEWNAME	Code review name
SSCM_REVIEWSTATUS	Code review status
SSCM_TIME	Time the trigger fired
SSCM_TRIGGERDESC	Trigger description
SSCM_USER	User that caused the event to occur
SSCM_VERSIONS *	File versions under code review