• Only values of the following attribute types can be safely read by and returned from scripts:
  • Short String
  • Medium String
  • Large String
  • Integer
  • Long
  • Decimal (since 4.0.1) provided as String. Helper class BigDecimal can be used for operations. Also see Use BigDecimal. Note: The returned string from a script must be a valid decimal string. To ensure your decimal conforms to a jazz decimal attribute type (i.e., 28 precision, 4 scale), use either isValid static method or BigDecimal constructor will throw com.ibm.team.workitem.shared.common.NumberFormatException with an invalid string.
    • To validate a string use (returns true iff decimalString is valid):

      var isValid= com.ibm.team.workitem.shared.common.BigDecimal.isValid(decimalString);
      						

    • To convert a string to a BigDecimal object use (throws NumberFormatException when decimalString is invalid):

      var decimal= new com.ibm.team.workitem.shared.common.BigDecimal(decimalString);
      						

    • To convert a BigDecimal object to a string use getStringRepresentation . Assuming decimal is a BigDecimal instance:

      var decimalString= decimal.getStringRepresentation();
      						

    • To compare BigDecimal objects use compareTo . Returns: -1, 0, or 1 as this instance is numerically less than, equal to, or greater than argument. Assuming decimal and otherDecimal are BigDecimal instances:

      var comparedValue= decimal.compareTo(otherDecimal);
      						

    • To evaluate for equality with BigDecimal objects use equals . Returns: true if the instances are numerically equal. Assuming decimal and otherDecimal are BigDecimal instances:

      var areEqual= decimal.equals(otherDecimal);
      						

  • Boolean
  • Timestamp as an ISO-8601 standard string. Use dojo.date.stamp to convert a Javascript Date object to and from an ISO-8601 string. When converting a Date object to a string set the milliseconds and the zulu options to true.
    • To convert the value of a timestamp attribute with the id attributeId to a Date object use:

      var date= dojo.date.stamp.fromISOString(workItem.getValue(attributeId));
      						

    • To convert a Date object to an ISO-8601 string use:

      var string= dojo.date.stamp.toISOString(date, {milliseconds:true, zulu:true});
      						

  • Limited support for Enumeration. See the Working with Enumerations section for more information about using Enumerations in scripts.
  • Limited support for Items

Currently there is no dedicated API to work with Items or Enumerations and scripts can only use the id of such attributes. If you need additional information, such as the name that corresponds to an Enumeration literal id, you can pass it to scripts using configuration parameters. See the Configuring additional script parameters section for more information.