{"id":5480,"date":"2018-10-14T00:36:20","date_gmt":"2018-10-14T00:36:20","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=5480"},"modified":"2019-12-05T06:18:53","modified_gmt":"2019-12-05T06:18:53","slug":"helix-core-trigger-script-type-reference-guide","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/helix-core-trigger-script-type-reference-guide\/","title":{"rendered":"Helix Core Trigger script type Reference Guide"},"content":{"rendered":"
<\/a>Each line in the trigger table has four fields.<\/div>\n\n\n\n\n\n
 <\/caption>\n
\n\n
\n\n
\n\n
<\/a>Trigger types are divided into six subtypes: changelist submission triggers, shelve triggers, fix triggers, form triggers, authentication triggers, and archive triggers.<\/div>\n
<\/a>Changelist submission triggers:<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>change-submit: Execute a changelist trigger after changelist creation, but before file transfer. Trigger may not access file contents.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>change-content: Execute a changelist trigger after changelist creation and file transfer, but before file commit.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
<\/a>To obtain file contents, use commands such as p4 diff2, p4 files, p4 fstat, and p4 print with the revision specifier @=change, where change is the changelist number of the pending changelist as passed to the script in the %changelist% variable.<\/div>\n
\n\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
\n\n
<\/a>Shelve triggers:<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>shelve-submit: Execute a pre-shelve trigger after changelist has been created and files locked, but prior to file transfer.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>shelve-commit: Execute a post-shelve trigger after files are shelved.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
\n\n
<\/a>Fix triggers:<\/div>\n
<\/a>The special variable %jobs% is available for expansion; it expands to one argument for every job listed on the p4 fix command line (or in the Jobs: field of a p4 change or p4 submit form), and must therefore be the last argument supplied to the trigger script.<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>fix-add: Execute fix trigger prior to adding a fix.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
\n\n
<\/a>Form triggers:<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>form-save: Execute a form trigger after the form contents are parsed, but before the contents are stored in the Perforce database. The trigger cannot modify the form specified in %formfile% variable.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>form-out: Execute form trigger upon generation of form to end user. The trigger can modify the form.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>form-in: Execute form trigger on edited form before contents are parsed and validated by the Perforce server. The trigger can modify the form.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>form-delete: Execute form trigger after the form contents are parsed, but before the form is deleted from the Perforce database. The trigger cannot modify the form.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>form-commit: Execute form trigger after the form has been committed for access to automatically-generated fields such as jobname, dates, etc.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n
<\/a>Authentication triggers:<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>auth-check: Execute an authentication check trigger to verify a user’s password against an external password manager during login, or when setting a new password If an auth-check trigger is present, the Perforce security configurable (and any associated password strength require\u00adment) is ignored, as authentication is now controlled by the trigger script.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
<\/a>auth-set: Execute an authentication set trigger to send a new password to an external password manager.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
\n\n
<\/a>Archive triggers:<\/div>\n
\n\n\n\n\n\n
\n
\u2022<\/div>\n<\/td>\n
\n
\n\n
<\/a>For changelist and shelve triggers (change-submit, change-content, change-commit, shelve-submit, shelve-commit, and shelve-delete), a file pattern in depot syntax. When a user submits a changelist that contains any files that match this file pattern, the script linked to this trigger is run. Use exclusionary mappings to prevent triggers from running on specified files.<\/div>\n
\n\n
<\/a>The command for the Perforce server to run when a matching path applies for the trigger type. Specify the command in a way that allows the Perforce server account to locate and run the command. The command must be quoted, and can take the variables specified below as arguments.<\/div>\n
<\/a>For change-submit and change-content triggers, changelist submission continues if the trigger script exits with 0, or fails if the script exits with a nonzero value. For change-commit triggers, changelist submission succeeds regardless of the trigger script’s exit code, but subsequent change-commit triggers do not fire if the script exits with a nonzero value.<\/div>\n
<\/a>For form-in, form-out, form-save, and form-delete triggers, the data in the specification becomes part of the Perforce database if the script exits with 0. Otherwise, the database is not updated.<\/div>\n
<\/a>The form-commit trigger type never rejects a change; it exists primarily so that scripts can access a job number (from the %formname% variable) during the process of job creation.<\/div>\n
<\/a>For fix-add and fix-delete triggers, fix addition or deletion continues if the trigger script exits with 0, or fails if the script exits with a nonzero value.<\/div>\n
<\/a>For auth-check and service-check triggers (fired by p4 login from standard users and service users respectively), the user’s typed password is supplied to the trigger command as standard input. If the trigger executes successfully, the Perforce ticket is issued. The user name is available as %user% to be passed on the command line.<\/div>\n
<\/a>For auth-set triggers, (fired by p4 passwd, but only after also passing an auth-check trigger check) the user’s old password and new password are passed to the trigger as standard input. The user name is available as %user% to be passed on the command line.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

Each line in the trigger table has four fields.   Field Meaning name The user-defined name of the trigger. A run of the same trigger name on contiguous lines is treated as a single trigger, so that multiple paths may be specified. In this case, only the command of the first such trigger line is used. type Trigger types…<\/p>\n","protected":false},"author":1,"featured_media":7923,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","_joinchat":[],"footnotes":""},"categories":[370],"tags":[5092,5071,278,818,5068],"class_list":["post-5480","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-perforce","tag-core","tag-helix","tag-script","tag-trigger","tag-type"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/5480","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=5480"}],"version-history":[{"count":2,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/5480\/revisions"}],"predecessor-version":[{"id":7924,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/5480\/revisions\/7924"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media\/7923"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=5480"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=5480"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=5480"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}