Implementing Triggers

The following topic describes how to use triggers to customize task processing.

Description

To map triggers to Create Task and Edit Task action:

Use the Current User -> Scripts... menu item to create Trigger / Create Task / * or Trigger / Edit Task / * script.
Click the Current Task -> Categories... menu item.
Choose the task category.
Click the Triggers tab.
Choose triggers for required actions.
Click the Save button.

To map triggers to Add Message action:

Use the Current User -> Scripts... menu item to create Trigger / Add Message / * script.
Click the Current Task -> Workflows... menu item.
Choose the workflow.
Click the Message Types tab.
Choose the message type.
Click the Triggers tab.
Choose triggers for required actions.
Click the Save button.

Create Task / BEFORE:

The following trigger complains if the Deadline task property has not been filled in for the task:

Copy Code

if(task.getDeadline() == null){
     throw new com.trackstudio.exception.UserMessageException("Please fill in the Deadline task property");
}
return task;

The following trigger complains if the Exists in Production custom field value has not been filled in for the task or equals Please Choose:

Copy Code

HashMap udfs = task.getUdfValues();
if (udfs.get("Exists in Production")==null || udfs.get("Exists in Production").equals("Please Choose"))
     throw new UserMessageException("No value selected for the Exists in Production field!");
return task;

Create Task / INSTEAD OF:

The following trigger chooses a random handler for the task:

Copy Code

String group = task.getHandlerGroupId();
String handler= task.getHandlerUserId();

if (task.getHandlerGroupId()!=null){
  ArrayList hand = AdapterManager.getInstance().getSecuredStepAdapterManager()
     .getTaskEditHandlerList(task.getSecure(),  task.getId(), task.getCategoryId());
  int size = hand.size();

  if (size>0){
     int pointer = new Random().nextInt(size);
     handler= ((SecuredUserBean)hand.get(pointer)).getId();
     group = null;
  }
}

if (task.getParentId()!=null){
    SecuredTaskTriggerBean nb = new SecuredTaskTriggerBean(task.getId(),task.getDescription(),
      task.getName(), task.getShortname(), task.getSubmitdate(), task.getUpdatedate(),
      task.getClosedate(), task.getActualBudget(), task.getBudget(), task.getDeadline(),
      task.getNumber(), task.getSubmitterId(), task.getHandlerId(), handler, group,
      task.getParentId(), task.getCategoryId(), task.getWorkflowId(), task.getStatusId(),
      task.getResolutionId(), task.getPriorityId(),task.getUdfValues(), task.getSecure());
    return nb.create(false);
} else return nb;

Create Task / AFTER:

The following script fills in the custom field See Also of type Task, with a list of tasks similar to the created one:

Copy Code

HashMap set = AdapterManager.getInstance().getSecuredTaskAdapterManager()
   .findSimilar(task.getSecure(),task.getId());
String similar="";
if (set!=null && !set.isEmpty()) {
   for (Iterator i = set.keySet().iterator(); i.hasNext();) {
      SecuredTaskBean s = (SecuredTaskBean) i.next();
      Float ratio = (Float) set.get(s);
      if (ratio.floatValue()>0.75f) {
         similar+="#"+s.getNumber()+"; " ;
      }
   }
}

if (similar.length()>0) {
   similar=similar.substring(0,similar.length()-2);
   AdapterManager.getInstance().getSecuredUDFAdapterManager().setTaskUDFValueSimple(
      task.getSecure(), task.getId(), "See Also", similar);
}
return task;

Edit Task/BEFORE:

The following trigger prevents users from saving a task with Budgeted Time less than Actual Time:

Copy Code

SecuredTaskBean currentState = new SecuredTaskBean(task.getId(),task.getSecure());
if (currentState.getActualBudget()!=null) {
   if ((task.getBudget()==null && currentState.getBudget()!=null)
      || (task.getBudget()!=null
           && task.getBudget().compareTo(currentState.getActualBudget())<0))
      throw new UserMessageException("Budgeted Time must be greater than Actual Time");
}
return task;

Edit Task/INSTEAD OF:

The following trigger creates messages of the type log for each deadline change using the Current Task -> Task... -> Edit link. Create message type log before using this trigger.

Copy Code

SecuredTaskBean oldOne = new SecuredTaskBean(task.getId(),task.getSecure());
Object oldDeadline=oldOne.getDeadline();
Object newDeadline = task.getDeadline();
String actionType=null;

if (oldDeadline==null && newDeadLine!=null) {
   actionType="Deadline was set.";
} else if (oldDeadline!=null && newDeadLine==null) {
   actionType="Deadline was reset.";
} else if (oldDeadline!=null && newDeadLine!=null) {
   if (newDeadline.after(oldDeadline)) {
      actionType="Deadline was extended.";
   } else if (newDeadline.before(oldDeadline)) {
      actionType="Deadline was moved up.";
   }
}

Object newOne = task.update(false);
if (actionType!=null) {
   SecuredMessageTriggerBean bean = new SecuredMessageTriggerBean(null,actionType,null,null,
      task.getDeadline(), task.getBudget(), task.getId(), task.getSecure().getUserId(), null,
      task.getPriorityId(), task.getHandlerId(), task.getHandlerUserId(), task.getHandlerGroupId(),
      CSVImport.findMessageTypeIdByName("log",
      task.getCategory().getName()), null, task.getSecure()).create();
}
return newOne;

Add Message / BEFORE:

The following trigger prevents users from closing a task that contains non-closed subtasks:

Copy Code

SecuredStatusBean ssb = AdapterManager.getInstance().getSecuredStepAdapterManager()
   .getNextStatus(message.getSecure(),
message.getTaskId(), message.getMstatusId());

if(ssb != null && ssb.isFinish()) {
   Set childredIdSet =message.getTask().getAllowedChildrenWithSubtasksMap().keySet();
   for(Iterator it = childredIdSet.iterator(); it.hasNext();) {
      String ch = (String)it.next();

      if (!AdapterManager.getInstance().getSecuredFindAdapterManager()
        .findTaskById(sc,ch).getStatus().isFinish()) {
         throw new UserMessageException("Subtask status is not final.");
      }
   }
}
return message;

Add Message / INSTEAD OF:

The following trigger implements the ability to vote for a task by adding a message. To use this script, create a custom field votesCounter of type Integer that will be used to count votes. Assign this trigger for a message type used to vote.

Copy Code

String udfValue = AdapterManager.getInstance().getSecuredUDFAdapterManager()
   .getTaskUDFValue(message.getSecure(), message.getTaskId(),"votesCounter");
String vote="0";
if (udfValue!=null && udfValue.length()>0)
   vote = udfValue;
int v = Integer.parseInt(vote);
v++;
AdapterManager.getInstance().getSecuredUDFAdapterManager().setTaskUDFValueSimple(
  message.getSecure(), message.getTaskId(),"votesCounter", v+"");
return message;

Add Message/AFTER:

The following trigger copies a task to the Knowledge Base (task #2 in this example) when user adds a message.

Copy Code

String copyTo = "2";
AdapterManager.getInstance().getSecuredTaskAdapterManager().pasteTasks(message.getSecure(),
   AdapterManager.getInstance().getSecuredTaskAdapterManager().findTaskIdByQuickGo(
     message.getSecure(), copyTo), new String[]{message.getTaskId()},"SINGLE_COPY");
return message;

The following trigger moves a task to the Knowledge Base (task #2 in this example) when user adds a message.

Copy Code

String moveTo= "2";
AdapterManager.getInstance().getSecuredTaskAdapterManager().pasteTasks(message.getSecure(),
     AdapterManager.getInstance().getSecuredTaskAdapterManager().findTaskIdByQuickGo(
       message.getSecure(), moveTo), new String[]{message.getTaskId()},"CUT");
return message;

Add Message / BEFORE:

The following trigger tracks custom field value changes in the message description:

Copy Code

if (message.getUdfValues()!=null && !message.getUdfValues().isEmpty()) {
    StringBuffer sb = new StringBuffer( 32 );
    for (Iterator it=message.getUdfValues().keySet().iterator();it.hasNext();) {
    String key = it.next().toString();
    String value = message.getUdfValues().get(key).toString();
    String oldValue = AdapterManager.getInstance().getSecuredUDFAdapterManager()
        .getTaskUDFValue(message.getSecure(),message.getTaskId(),key);
    if ((oldValue!=null && !oldValue.equals(value))
        || (oldValue==null && value!=null)) {
        if (sb.length() == 0) {
           sb.append("<b>");
        }
        sb.append("'").append(key).append(" changed from ")
          .append(oldValue).append(" to ").append(value).append("<br/>").append("\n");
    }
    }
    if (sb.length() >0) {
    sb.append("</b><br/><hr/><br/>\n").append(message.getDescription());

    return new SecuredMessageTriggerBean(message.getId(), sb.toString(),
                         message.getTime(), message.getHrs(), message.getDeadline(),
                         message.getBudget(), message.getTaskId(), message.getSubmitterId(),
                         message.getResolutionId(), message.getPriorityId(), null,
                         message.getHandlerUserId(), message.getHandlerGroupId(),
                         message.getMstatusId(), message.getUdfValues(), message.getSecure());
    }
}
return message;