Articles

[Collapse]CodeCollaborator 5
 [Expand]Big Picture/viewarticle/20018/
 [Collapse]Server Administration/viewarticle/20087/
  [Expand]Installation
  [Expand]System Administration
  [Collapse]Code Collaborator Configuration/viewarticle/20055/
    General Settings/viewarticle/20048/
    User Management/viewarticle/20047/
   [Expand]Groups/viewarticle/20061/
    E-Mail Configuration/viewarticle/20044/
    Version Control/viewarticle/20039/
    Custom Fields/viewarticle/20038/
    Role Configuration/viewarticle/20040/
    Workflow Configuration/viewarticle/20043/
    Triggers/viewarticle/20069/
    Notification Templates/viewarticle/20037/
    Automatic Links/viewarticle/20036/
    Variable Substitution/viewarticle/20034/
    Archiving Data/viewarticle/20032/
    System Status/viewarticle/20035/
 [Expand]Web User's Guide/viewarticle/20071/
 [Expand]Clients/viewarticle/20077/
 [Expand]Version Control Integration/viewarticle/20031/
 [Expand]External Integrations/viewarticle/20301/
 [Expand]Techniques & Best Practices/viewarticle/20302/
 [Expand]Appendices/viewarticle/20078/
Updated: 4/18/2011 Applies To: CodeCollaborator 5 Rating: No votes Click to rate: PoorNot badAverageGoodExcellent

Triggers

Top Previous Next

Code Collaborator can execute an external script or application when certain events occur. This is useful when integrating Code Collaborator with other systems such as issue-tracking, ALM, or builds.

Possible uses of triggers include:

Mirror defects created in Code Collaborator into an external issue-tracking system.
Set a flag in a system when a review completes.
Intercept all notifications sent from Code Collaborator to log them or to send the notification in a way other than standard email or RSS.
Send notifications to a mailing list when certain events occur.

The Triggers section of the Administration page lets you configure the various triggers:

Review Created - Review created. No files or participants yet.
Review Phase Changed - Review phase changed, e.g. Planning -> Inspection or Inspection -> Cancelled.
Added Files - Files and/or changelists attached to a review.
Notifications Sent - A notification (email, RSS, etc.) was sent to someone.
Defect Activity - A defect was added, modified, or marked open/fixed. Use the defect unique ID to determine the difference.
User Created - A new user was created. This runs whether or not the creation was automated or manual.

admin-triggers

The Executable field specifies the application to run. If this is a script, use the script executable here (e.g. Perl, PHP, Python). This must be an absolute path to the application; the form will complain if the file cannot be found or executed.

The Parameters field is a list of arguments to supply to the executable. If this is a script, the absolute path to the script itself is typically the first argument.

There are many special arguments you can supply that will be replaced by Code Collaborator when the application is executed. For example, ${review.title} will be replaced by the title of the review associated with the given triggering event. See the Variable Substitution chapter for details.



© 2014 SmartBear Software. All rights reserved.
Email Send feedback on this document