JavaScript API for IBM Process Designer

Parameters in italics are optional.

Namespace Summary

NamespaceSummary
tw.object The object namespace is used to initialize complex IBM BPM objects.
tw.local The local namespace containing all private, input and output variables.
tw.system The system namespace containing process and step constants.
tw.epv The epv namespace containing the EPVs attached to a process.
tw.env The environment namespace containing all environment variables.

Other Namespaces

NamespaceSummary
OrgNamespace the 'tw.system.org' object contains useful methods to access the User Organization.
TWHelpRequest An instance of a help request.
TWInstallNamespace The 'tw.system.install' object contains useful variables and methods about the installation history.
TWInstallStatusesNamespace The 'tw.system.install.Statuses' object contains the constant values for the possible statuses.
TWPerfNamespace the 'tw.perf' object contains runtime data from the Performance Server
TWServiceClass The TW Object which is the wrapper around all variables in the system.
TWServiceSystemNamespace the 'tw.system' object contains useful variables and constants about the system and this particular process.

Object Summary

ObjectSummary
ActivitySummary A list of this object is returned by the Activity Summary Services.
IntegrationComponent This class provides access to IntegrationComponents via JavaScript.
Map This class is a simple Map (Associative Array) implementation for JavaScript. The only objects that can be assigned to a map are primitives and business objects.
PathStep This Object holds the info about traversed path.
ProcessHistoricalStatistics The object returned by the Process Historical Statistics Services.
ProcessHistoricalStatisticsProperties The object is used as input to the Process Historical Statistics Services. It allows to influence the returned result set.
ProcessInstanceListItem A list of this object is returned by the Process Instance List Services.
ProcessInstanceListProperties The object is used as input to the Process Instance List Services. It allows to filter or limit the list of returned process instances.
ProcessSummary The object returned by the Process Summary Services.
ProjectedPathStep This Object holds the info about projected path.
Record TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object. or object[""].
Serializer Provides serialize/deserialize methods for IBM BPM variables.
TaskDueData The object returned by the Task Due Services.
TaskDueProperties The object is used as input to the Task Due Services. It allows to filter or limit the list of returned task due slices.
TaskDueSummary The number of tasks in a risk state for a specific time slot.
TaskListData The object returned by the Task List Services.
TaskListItem The object representing a single Task List Item nested in the TaskListData object returned by the Task List Services.
TaskListProperties The object is used as input to the Task List Services. It allows to filter or limit the list of returned tasks.
TeamDashboardSupport Dashboard coach views support.
TeamMemberTaskSummary The object returned by the Team Member Summary Services.
TeamRosterEntry A list of this object is returned by the Team Roster Services.
TeamTaskSummary The object returned by the Team Summary Services.
TWAdhocStartingPoint Represent an adhoc starting point.
TWAssetTypes The reference link asset type.
TWChart Chart object for reporting. Can take a layout name as constructor to create a chart in a process. Normally exposed as chart variable in contexts where available. Deprecated. Use coach-based dashboards instead.
TWDate Represents a date.
TWDocument Represents a document.
TWDocumentSearchTypes Constant values for possible document search types.
TWDocumentTypes Constant values for document types.
TWLink A Reference link in a documentation section.
TWLinkTypes The reference link type.
TWLogger Helper class allowing errors, warnings and debug results to be logged to 'tw-javascript.log'. This class is available as 'log' variable in all javascript fields in IBM BPM.
TWManagedFile Represents a managed file for a particular snapshot of a Process App/Toolkit.
TWManagedFileTypes Contains constants for managed file types.
TWModelNamespace the 'tw.system.model' object contains useful functions to get model objects.
TWObject TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object. or object[""].
TWParticipantGroup Contains useful methods to access the team.
TWProcess Represents a BPD.
TWProcessApp A Process App/Toolkit object.
TWProcessAppDefaults Contains the defaults for this version of the Process App/Toolkit.
TWProcessAppSnapshot A Process Application object.
TWProcessInstance Represents a process instance.
TWProcessInstanceStatuses Constants to represent statuses of TWProcessInstance.
TWProcessPerformanceMetric To access the Process Performance Metric objects method the user must have access as defined in Expose performance metrics.
TWRelationshipTypes The link type of a reference link.
TWReport From this object one can access aspects of the report definition. Deprecated. Use coach-based dashboards instead.
TWReportFilter This object exists in Report Filter Layouts only. It is used to give access to runtime and author set values of a report filter.
TWRole Contains useful methods to access the Role.
TWSavedSearch Represents a saved search object.
TWScoreboard Represents a scoreboard object. Deprecated. Use coach-based dashboards instead.
TWSearch Contains properties and methods for search.
TWSearchColumn Contains properties for search column.
TWSearchColumnMetaData Search column information for returning and querying against columns.
TWSearchColumnMetaDataValueTypes Value types of the search column metadata.
TWSearchColumnProcessColumns Contains constants for searchable column names of a Process.
TWSearchColumnProcessInstanceColumns Contains constants for searchable column names of a Process Instance.
TWSearchColumnTaskColumns Contains constants for searchable column names of a Task.
TWSearchColumnTypes Contains constants for search column types operations.
TWSearchCondition Contains properties for a search condition.
TWSearchConditionOperations Contains constants for search condition operations.
TWSearchMetaData Used to describe data that can be used to perform searches.
TWSearchOptions Wraps several parameters for the behavior of TWSearch into a single object.
TWSearchOrdering Contains properties for search ordering.
TWSearchOrderingOrders Contains constants for search orders operations.
TWSearchOrganizeByTypes Contains constants for task organized by types.
TWSearchResultRow Search results row object.
TWSearchResults Search results object.
TWService Represents an executable service.
TWServiceTypes Constants to represent types of services.
TWTask Contains useful methods to access the Task.
TWTaskPriorities Contains constants for priority types.
TWTaskStatuses Contains constant values for possible statuses.
TWTeam Contains useful methods of team.
TWTimerInstance An instance of a timer waiting.
TWUser Contains useful methods to access the User.
TWUserLocalePreferences Holds information about a user's locale preferences.
UserDashboardSupport Dashboard coach views support.
UserInfo The User Information.
XMLDocument Represents an XML Document.
XMLElement Represents an XML Element.
XMLNodeList Represents a list of XMLElements.

ActivitySummary

A list of this object is returned by the Activity Summary Services.

Property Summary
String bpdFlowObjectId The bpd flow object id of the activity for the current bpd and app id.
Integer countActive The number of process instances in state 'Active' in this activity for the current bpd and app id.
Integer countAtRisk The number of process instances in state 'AtRisk' in this activity for the current bpd and app id.
Integer countOnTrack The number of process instances in state 'OnTrack' in this activity for the current bpd and app id.
Integer countOverdue The number of process instances in state 'Overdue' in this activity for the current bpd and app id.
String name The name of the activity for the current bpd and app id.

IntegrationComponent

This class provides access to IntegrationComponents via JavaScript.

Property Summary
TWObject resultArray This object contains all the results in a standard Structure object. The property is only available after execute() is called.
Method Summary
IntegrationComponentObject execute() Executes the integration component.
IntegrationComponent getByName(String name) Finds an Integration Component using its name. If no component can be found for the provided name an exception is thrown.

Map

This class is a simple Map (Associative Array) implementation for JavaScript. The only objects that can be assigned to a map are primitives and business objects.

Property Summary
TWObject resultArray This object contains all the results in a standard Structure object. The property is only available after execute() is called.
Method Summary
boolean containsKey(Object key) Returns true if the key exists.
Object get(Object key) Returns the value in the map for a particular key.
Object[] keyArray() Returns an array of all keys in the map.
Object put(Object key , Object value) Adds a new entry into the map.
void remove(Object key) Removes the key from the map.
int size() The number of items in this map.
Object[] valueArray() Returns an array of all values in map.

PathStep

This Object holds the info about traversed path.

Property Summary
Step fromStep Provides the FROM Step for the Link
String pathId Provides the connector path or link id
String processFlowPathId Provides the connector path or link id which can be referred to PDW view table
Step toStep Provides the TO Step for the Link

ProcessHistoricalStatistics

The object returned by the Process Historical Statistics Services.

Property Summary
Integer averageInstanceDuration A list of average instance duration for a process of this type.
TaskAllTimeStatistics[] taskAllTimeStatistics A list of all time statistics for a process of this type.
TaskHistoricalGanttStatistics[] taskHistoricalGanttStatistics A list of historical Gantt statistics for a process of this type.
TimingIntervalHistoricalStatistics[] timingIntervalHistoricalStatistics A list of timing interval historical statistics of this type.

ProcessHistoricalStatisticsProperties

The object is used as input to the Process Historical Statistics Services. It allows to influence the returned result set.

Property Summary
Boolean includeAllTimeTaskStatistics Controls whether a list of all time task statistics (task minimum and maximum completion times) should be returned. Optional field. Default: false.
Boolean includeAverageInstanceDuration Controls whether a list of average instance durations should be returned. Optional field. Default: false.
Boolean includeGanttTaskStatistics Controls whether a list of gantt task statistics (i.e average duration , average relative start time, percent executed , activity counter) should be returned. Optional field. Default: false.
Boolean includeTimingInvervalStatistics Controls whether a list of timing interval statistics should be returned. Optional field. Default: false.
String searchFilter Return only entries that contain the specified text. Optional field.

ProcessInstanceListItem

A list of this object is returned by the Process Instance List Services.

Property Summary
Integer age The age of the process instance in minutes.
String dueDate The due date of the process instance.
Boolean estimatedCompletionDateEnabled Indicates wheather 'Allow Projected Path Management' is enabled for this process instance.
String id The id of the process instance.
String name The name of the process instance.
String riskState The risk state of the process instance.

ProcessInstanceListProperties

The object is used as input to the Process Instance List Services. It allows to filter or limit the list of returned process instances.

Property Summary
Integer beginIndex Skip the given amount of process instances from the top of the result set. Optional field. Default: 0
Integer maxRows Limit the number of the returned process instances to the given number. Optional field. Default: 25
String riskState Return only process instances which are in the given state. Valid values are OnTrack, AtRisk, Overdue. Optional field. If not set, all process instances are returned.
String searchFilter Return only process instances that contain the specified text. Optional field.
String sortCriteria Sort the result list by the given value. Valid values are AGE, RISK, DUEDATE, ALPHABET. Optional field. Default: DUEDATE
String stepId Return only process instances that are currently in the specified step/activity. Optional field.
String stepRiskState Return only process instances that are currently in step/activity (specified by stepId) in the specified riskState (OnTrack, AtRisk, Overdue). Has no effect when stepId is not specified. Optional field.

ProcessSummary

The object returned by the Process Summary Services.

Property Summary
Integer countActive The number of active tasks of the process this summary is for.
Integer countAtRisk The number of tasks at risk of the process this summary is for.
Integer countOnTrack The number of tasks on track of the process this summary is for.
Integer countOverdue The number of tasks overdue of the process this summary is for.
String description The description of the process this summary is for.
String name The name of the process this summary is for.
String processAppId The id of the process application this summary is for.
String processAppName The name of the process application this summary is for.
String processId The id of the process this summary is for.

ProjectedPathStep

This Object holds the info about projected path.

Property Summary
Date dueDate Optional property, only available for Human task. It is a Due date for the activity.
Long duration Provides the duration it took for the activity.
boolean isDueDateCalculated Returns True, if the DueDate was calculated from duration. False, if a specific due date was specified
ProjectedPathStep nextProjectedPathStep Provides the next Projected Path Step.
Integer priority Optional property, only available for Human task. There are five priorities, and a value for not being set: 10-highest,20-high, 30-normal, 40-low, 50-lowest, -1-Not set.
Step step Step is an entity which maps to the static data describing the BPD. It is a flow object within a diagram.
TWTask[] tasks Optional property, only available if this is the human task to be performed.

Record

TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object. or object[""].

Property Summary
int arrayLength Deprecated. arr.arrayLength is deprecated. Use arr.listLength instead.
Returns the length of the list properties of this object.
#[] listAllSelected Returns an array of all of the selected items in this array. The items are returned ordered so that the most recently selected item is in position 0 and the least recently selected at the end.
Integer[] listAllSelectedIndices Returns an array of all of the selected indices of this array. The indices are returned ordered so that the most recently selected index is in position 0 and the least recently selected at the end.
int listLength Returns the length of the list properties of this object.
# listSelected Returns the most recently selected item in the array or undefined if there are no selected items.
Integer listSelectedIndex Returns the index of the most recently selected item in the array or -1 if there are no selected indices.
String[] propertyNames Returns the names of the properties defined in this object as an Array.
Method Summary
Array arrayToNativeArray() Deprecated. arrayToNativeArray is Deprecated. Use listToNativeArray instead.
Converts this TWObject array to a Native JavaScript Array object.
XMLElement describe() Returns an xml structure of the properties and structure associated with this object. This is very useful for debugging.
void insertIntoArray(int position , Object object) Deprecated. use insertIntoList() instead.
Adds a value to the list in a particular position. The list will be resized to fit the objects.
void insertIntoList(int position , Object object) Adds a value to the list in a particular position. The list will be resized to fit the objects.
void listAddSelected(int index) Adds an item from the list of selected items.
void listClearAllSelected() Removes all items from the selection list.
boolean listIsSelected(int index) Returns true if item index is selected, false if not.
void listRemoveSelected(int index) Removes an item from the list of selected items.
Array listToNativeArray() Converts this TWObject array to a Native JavaScript Array object.
void remove(String propertyName) Removes a property from this object.
void removeIndex(int listIndex) Removes a value from the list. The list will be resized to fit the remaining objects.
XMLElement toXML() Returns an xml structure of the properties associated with this object.
String toXMLString() Returns an xml structure as String of the properties associated with this object.

Serializer

Provides serialize/deserialize methods for IBM BPM variables.

Method Summary
Object fromXml(TWObject variable) Deserialize a String or XMLElement object to a IBM BPM variable.
XMLElement toXml(TWObject variable) Serialize an object to XML.

TaskDueData

The object returned by the Task Due Services.

Property Summary
Integer futureCount Number of tasks in the future of the given time slot.
Integer oldCount Number of tasks older than the given time slot.
TaskDueSummary[] taskDueSummaries A list of TaskDueSummary objects (slices).
String taskIndexLastIndexStartTime The date of the last lucene index start time as ISO 8601 date string in UTC.
Integer taskIndexUpdateInterval The number of seconds between lucene task index updates.

TaskDueProperties

The object is used as input to the Task Due Services. It allows to filter or limit the list of returned task due slices.

Property Summary
TaskListInteractionFilter interactionFilter Return only tasks which match the given interaction filter. Valid values are ASSESS_AND_WORK_ON, ASSESS_AVAILABLE, CHECK_COMPLETED, WORK_ON. Optional field. If not set, ASSESS_AND_WORK_ON is used.
String searchFilter Return only tasks that contain the specified text. Optional field.
String taskDueSelectionEndDate Return only task due slices for tasks which are due before the given date as ISO 8601 date string in UTC. Optional field. If not set, task due slices for all times are returned.
String taskDueSelectionStartDate Return only task due slices for tasks which are due after the given date as ISO 8601 date string in UTC. Optional field. If not set, task due slices for all times are returned.
String teamId Return only task due slices for tasks which are assigned to the given team id. Optional field. If not set, task due slices for all tasks are returned.
String userId Return only task due slices for tasks which are assigned to the given user id. Optional field. If not set, task due slices for all tasks are returned.

TaskDueSummary

The number of tasks in a risk state for a specific time slot.

Property Summary
Integer atRisk Number of tasks in risk state "AtRisk" for the given time slot.
String endDate The end date of the slice as ISO 8601 date string in UTC.
Integer onTrack Number of tasks in risk state "OnTrack" for the given time slot.
Integer overdue Number of tasks in risk state "Overdue" for the given time slot.
String startDate The start date of the slice as ISO 8601 date string in UTC.

TaskListData

The object returned by the Task List Services.

Property Summary
UserInfo[] assignedUsers A list of UserInfo objects of users assigned to tasks in the list.
Map riskStateSummary Map contains how many tasks in the list are in which risk state. Key: risk state; Value: number of tasks in that category.
String taskIndexLastIndexStartTime The date of the last lucene index start time in UTC timezone (ISO date string).
Integer taskIndexUpdateInterval The number of seconds between lucene task index updates.
TaskListItem[] tasks A list of TaskListItem objects.
Integer total The total number of tasks in the list.

TaskListItem

The object representing a single Task List Item nested in the TaskListData object returned by the Task List Services.

Property Summary
String assignedToTeamId The team id of the team the task is assigned to.
String assignedToTeamName The name of the team the task is assigned to.
String assignedtoUserFullName The full name of the user the task is assigned to.
String assignedToUserId The user id of the user the task is assigned to.
String closedDate The closed date of the task.
String dueDate The due date of the task.
String id The id of the task.
Boolean isAtRisk States whether the task is at risk or not.
Integer priority The priority of the task.
String processInstanceId The id of the process instance the task belongs to.
String processInstanceName The name of the process instance the task belongs to.
String riskState The risk state the task is in.
String subject The subject of the task.

TaskListProperties

The object is used as input to the Task List Services. It allows to filter or limit the list of returned tasks.

Property Summary
TaskListRiskStates[] collapsedRiskStates Return only tasks which are in the given state(s). Optional field. If not set, all process instances are returned.
DateRangeString dueSlice The date range for which tasks should be returned. Optional field. If not set, all tasks are returned.
Boolean includeAssignedUsers Controls whether a list of users assigned to the tasks in the list should be returned. Optional field. Default: false.
Boolean includeRiskStateSummary Controls whether a Map containing how many tasks in the list are in which risk state should be returned. Optional field. Default: false
TaskListInteractionFilter interactionFilter Return only tasks which match the given interaction filter. Valid values are ASSESS_AND_WORK_ON, ASSESS_AVAILABLE, CHECK_COMPLETED, WORK_ON. Optional field. If not set, ASSESS_AND_WORK_ON is used.
String searchFilter Return only tasks that contain the specified text. Optional field.
String teamId Return only tasks which are assigned to the given team id. Optional field. If not set, all tasks are returned.
String userId Return only tasks which are assigned to the given user id. Optional field. If not set, all tasks are returned.

TeamDashboardSupport

Dashboard coach views support.

Method Summary
TeamRosterEntry[] retrieveTeamMemberList( String timezone) Retrieves the list of team members of this team for use with the Team Roster coach control
TeamTaskSummary retrieveTeamSummary( String searchFilter , String timeZoneAsString , Boolean checkAuthorization) Retrieve summary data of a Team's active tasks.
ChartData retrieveTeamTaskTrend( String units , Integer numPeriods , String endPeriod , String timezone , String searchFilter , Boolean checkAuthorization) Returns a ChartData object composing data series for New tasks and Completed tasks.

TeamMemberTaskSummary

The object returned by the Team Member Summary Services.

Property Summary
Integer countAtRisk The number of tasks at risk of the current user for this summary.
Integer countOnTrack The number of tasks on track of the current user for this summary.
Integer countOverdue The number of tasks overdue of the current user for this summary.
String fullName The full name of the current user for this summary.
String name The name of the current user for this summary.
Integer tasksCompletedToday The number of tasks completed today of the current user for this summary.
Integer totalOpenTasks The number of total open tasks of the current user for this summary.
String userId The user id of the current user for this summary.

TeamRosterEntry

A list of this object is returned by the Team Roster Services.

Property Summary
String emailAddress The email address of the team member.
String fullName The full name of the team member.
String jobTitle The job title of the team member.
String name The name of the team member.
String phoneNumber The phone number of the team member.
Integer tasksCompletedToday The number of tasks completed today for the team member.
Integer totalOpenTasks The number of open tasks for the team memeber.
String userId The user id of the team member.

TeamTaskSummary

The object returned by the Team Summary Services.

Property Summary
Integer countAtRisk The number of tasks at risk for the team.
Integer countOnTrack The number of tasks on track for the team.
Integer countOverdue The number of overdue tasks for the team.
String description The description of the team.
String name The name of the team.
String processAppId The process app id of the team.
String processAppName The process app name of the team.
Integer tasksCompletedToday The number of tasks completed today for the team.
String teamId The team id of the team.
Integer totalOpenTasks The number of total open tasks for the team.

TWAdhocStartingPoint

Represent an adhoc starting point.

Property Summary
String id The id of the adhoc starting point.
String name The name of the adhoc starting point.
TWProcessInstance processInstance The process instance this adhoc starting point belongs to.
Method Summary
String[] startNew() Triggers an adhoc start event.

TWAssetTypes

The reference link asset type.

Property Summary
String CHANGE_REQUEST The Change Request asset type.
String DEFECT The Defect asset type.
String PLAN The Plan asset type.
String PLAN_ITEM The Plan Item asset type.
String REQUIREMENT The Requirement asset type.
String REQUIREMENTS_CHANGE_REQUEST The Requirements Change Request asset type.
String REQUIREMENTS_COLLECTION The Requirements Collection asset type.
String RESOURCE The Resource asset type.
String TASK The Task asset type.
String TEST_CASE The Test Case asset type.
String TEST_EXECUTION_RECORD The Test Execution Record asset type.
String TEST_PLAN The Test Plan asset type.
String TEST_RESULT The Test Result asset type.
String TEST_SCRIPT The Test Script asset type.

TWChart

Chart object for reporting. Can take a layout name as constructor to create a chart in a process. Normally exposed as chart variable in contexts where available. Deprecated. Use coach-based dashboards instead.

Property Summary
Array bottomLabels Deprecated. Use coach-based dashboards instead.
list of labels set on this chart.
String chartType Deprecated. Use coach-based dashboards instead.
The chart type.
boolean hasBarSeries Deprecated. Use coach-based dashboards instead.
Returns true if this chart type takes bar series.
boolean hasDialSeries Deprecated. Use coach-based dashboards instead.
Returns true if this chart type takes dial series.
boolean hasLineSeries Deprecated. Use coach-based dashboards instead.
Returns true if this chart type takes line series.
boolean hasPieSeries Deprecated. Use coach-based dashboards instead.
Returns true if this chart type takes pie series.
boolean seriesCount Deprecated. Use coach-based dashboards instead.
Returns the number of series applied to this chart.
Method Summary
void addBottomLabels() Deprecated. Use coach-based dashboards instead.
(series)set the bottom labels.
void addSeries(int index , String name , String type , Object series) Deprecated. Use coach-based dashboards instead.
Adds a series to the chart. (index, name, type, series) : index - the index of this series (for ordering), name - the series name used in legends, type - type of series (bar,line,pie,dial), series - comma separated list, list, TWObject containing the data for this series.
String display(int width , int height , boolean removeDemoData) Deprecated. Use coach-based dashboards instead.
(width, height)display the chart. Returns the HTML needed.
String displayCSVTable() Deprecated. Use coach-based dashboards instead.
Displays a comma separated table of the chart data.
String displayTable() Deprecated. Use coach-based dashboards instead.
Displays an HTML table of the chart data.
Object[] getSeriesData() Deprecated. Use coach-based dashboards instead.
(series) get the data off a series.
String getTypeName() Deprecated. Use coach-based dashboards instead.
Returns the name of the type.
void setFeature(String feature , Object value) Deprecated. Use coach-based dashboards instead.
Sets or changes a feature of the chart. Supports the following features: axis Change the left axis of the chart. You can set it to auto with feature="auto", or set it to a fixed axis by using the string argument "fixed,,,". , and have to be numerical values defining the axis scope. title Changes the top title of the chart if it got one. The value should be the title text. leftLabel Changes the left label of the chart if it got one. The value should be the text of left label. bottomLabel Changes the bottom label of the chart if it got one. The value should be the text of bottom label. colorTable Changes the default color theme of the chart if used. The value is an array of color items understood according to the chart package used. The argument can either be an array or a comma separated string..
void setLayout(String layoutID) Deprecated. Use coach-based dashboards instead.
Updates chart's layout.
void setLayoutByName(String layoutName) Deprecated. Use coach-based dashboards instead.
Updates chart's layout through looking up current and underneath contexts.

TWDate

Represents a date.

Method Summary
String format() Format the date according to the default string format.
String format( String formatString , String timeZoneString) Converts a date to a string representation using the specific format and timezone provided. The optional formatString must follow the syntax and rules laid down for the java.text.SimpleDateFormat class: if omitted, the "short" format is used. The optional timeZoneString must be a valid time zone identifier according to the rules in java.util.TimeZone.
String formatDate( String dateStyle) Converts a date to a string representation using a specific format. The optional parameter 'dateStyle' can take the values: short, medium, long, full: if omitted, the "medium" style is used.
String formatDateTime( String dateStyle , String timeStyle) Converts this date and time to a string representation using specific formats. The optional parameters 'dateStyle' and 'timeStyle' can take the values: short, medium, long, full: if omitted, the "medium" style is used for both.
String formatTime( String timeStyle) Converts a time to a string representation using a specific format. The optional parameter 'timeStyle' can take the values: short, medium, long, full: if omitted, the "medium" style is used.
int getDate() Returns the day of the month as an integer.
int getDay() Returns day of the week as integer where the first day is Sunday and equal to 1.
int getDayOfWeek() This method returns an integer value representing the day of week for the specified date.
int getFullYear() Returns four-digit year as integer.
int getHours() Returns the hour within the day (24h).
int getMilliseconds() Returns the milliseconds within the seconds.
int getMinutes() Returns the minutes within the hour as an integer.
int getMonth() Returns month number as integer where January is the first month and equal to 0.
int getSeconds() Returns the seconds within the minute.
int getTime() This method returns an integer value representing the number of seconds since midnight 01/01/1970 for the specified date.
void getTimezoneOffset() Returns raw offset from GMT in minutes.
int getUTCDate() Returns the day of the month as an integer in Coordinated Universal Time (UTC).
int getUTCDay() Returns day of the week as integer where the first day is Sunday and equal to 1 in Coordinated Universal Time (UTC).
int getUTCFullYear() Returns four-digit year as Integer in Coordinated Universal Time (UTC).
int getUTCHours() Returns hour within day as Integer in Coordinated Universal Time (UTC).
int getUTCMilliseconds() Returns milliseconds within second as Integer in Coordinated Universal Time (UTC).
int getUTCMinutes() Returns minute within hour as Integer in Coordinated Universal Time (UTC).
int getUTCMonth() Returns month number as Integer where January is the first month and equal to 0 in Coordinated Universal Time (UTC).
int getUTCSeconds() Returns seconds within minute as Integer in Coordinated Universal Time (UTC).
int getUTCTime() This method returns an integer value representing the number of seconds since midnight 01/01/1970 UTC for the specified date.
void parse(String dateAsString , String formatString , String timeZoneString , String timeZoneString , String localeString) Sets the value of the date by parsing dateAsString using the formatString and optional timeZoneString and optional localeString provided. The formatString must follow the syntax and rules laid down for the java.text.SimpleDateFormat class. The optional timeZoneString must be a valid time zone identifier according to the rules in java.util.TimeZone. The optional localeString must be a valid locale designation according to the rules in java.util.Locale.
void setDate(int dayOfMonth) Sets day of the month to the number supplied in parameter(must be valid for month).
void setDay(int dayOfWeek) Sets day of week to integer supplied in day of week where Sunday is 1 and the first day of the week.
void setFullYear(int year) Sets the year to four-digit number in full year.
void setHours(int hours) Sets the hour on the 24 hour clock to the specified hour value. The Midnight hour is hour 0.
void setMilliseconds(int millis) Sets the milliseconds within the second to the value in milliseconds.
void setMinutes(int minutes) Sets the minutes within the hour.
void setMonth(int month) Sets the month to the number indicated in month number. January is the first month and is equal to 0. Number must be a valid month 0-11.
void setSeconds(int seconds) Sets the seconds within the minute to the value in seconds.
void setTime(int time) This method is used to set the time of a Date object according to local time.
void setUTCDate(int dayOfMonth) Sets day of the month to the number supplied in day of month (must be valid for month) in Coordinated Universal Time (UTC).
void setUTCDay(int dayOfWeek) Sets day of week to integer supplied in day of week where Sunday is 1 and the first day of the week in Coordinated Universal Time (UTC).
void setUTCFullYear(int year) Sets the year to four-digit number in full year in Coordinated Universal Time (UTC).
void setUTCHours(int hours) Sets the hour on 24 hour clock to hour indicated in hour in Coordinated Universal Time (UTC). The Midnight hour is hour 0.
void setUTCMilliseconds(int millis) Sets the milliseconds within the second to the value in milliseconds in Coordinated Universal Time (UTC).
void setUTCMinutes(int minutes) Sets the minutes within the hour in Coordinated Universal Time (UTC).
void setUTCMonth(int month) Sets the month to the number indicated in month number. January is the first month and is equal to 0. Number must be a valid month 0-11 in Coordinated Universal Time (UTC).
void setUTCSeconds(int seconds) Sets the seconds within the minute to the value in seconds in Coordinated Universal Time (UTC).
void setUTCTime(int time) This method is used to set the time of a Date object according to UTC time.
Date toNativeDate() Converts a TWDate into a JavaScript Date object.

TWDocument

Represents a document.

Property Summary
TWDocument[] allVersions Returns an array containing all versions of the document.
String contentType Returns the content type of the document.
boolean hideInPortal Returns whether the document is hidden in Portal.
String id Returns the id of the document.
TWDate modificationDate Returns the modification date of the document.
TWUser modifiedBy Returns the user who modified the document.
String name Returns the name of the document.
TWProcessInstance processInstance Returns the process instance to which this document belongs.
String type Returns the type of the document (either TWDocument.Types.File or TWDocument.Types.URL).
TWDocumentTypes Types Contains constant values for document types.
String uri Returns the file name of the document.
int version Returns the version number the document.
Method Summary
TWDocument addVersion(String type , String fileLocation , TWUser user) Creates a document of the specified type (either TWDocument.Types.File or TWDocument.Types.URL) with the specified file name (and optionally the specified user), and returns the created document.
void deleteAllVersions() Deletes all versions of this document.
void writeDataToFile(String filename) Writes the data to the specified file name if the document is of type TWDocument.Types.File; otherwise, it does nothing.

TWDocumentSearchTypes

Constant values for possible document search types.

Property Summary
String All All properties must be the same to return the document.
String Any Any property must be the same to return the document.

TWDocumentTypes

Constant values for document types.

Property Summary
String File The document represents a file.
String URL The document represents a URL.

TWLink

A Reference link in a documentation section.

Property Summary
String assetType The asset type that the reference link defines.
String assetTypeNamespace The namespace identifier for the asset type.
TWAssetTypes AssetTypes Out of the box list of asset types.
String linkType Defines the link type.
TWLinkTypes LinkTypes Out of the box list of link types.
String name Defines the link name.
String relationshipType The relationship this reference link defines.
String relationshipTypeNamespace The namespace identifier for the relationship type.
TWRelationshipTypes RelationshipTypes Out of the box list of relationship types.
String url Defines the link URL.

TWLinkTypes

The reference link type.

Property Summary
String FILE The file link type.
String OSLC The OSLC link type.

TWLogger

Helper class allowing errors, warnings and debug results to be logged to 'tw-javascript.log'. This class is available as 'log' variable in all javascript fields in IBM BPM.

Property Summary
boolean debugEnabled Returns 'true' if Debug level logging is enabled in the log4j configuration file.
boolean infoEnabled Returns 'true' if Info level logging is enabled in the log4j configuration file.
Method Summary
void debug(String text) Writes to the 'tw-javascript.log' with FINE severity. If the level is set higher than FINE in the log4j configuration, this method might not log anything.
void error(String text) Writes to the 'tw-javascript.log' with ERROR severity. If the level is set higher than ERROR in the log4j configuration, this method might not log anything.
void info(String text) Writes to the 'tw-javascript.log' with INFO severity. If the level is set higher than INFO in the log4j configuration, this method might not log anything.
void warn(String text) Writes to the 'tw-javascript.log' with WARNING severity. If the level is set higher than WARNING, this method might not log anything.

TWManagedFile

Represents a managed file for a particular snapshot of a Process App/Toolkit.

Property Summary
String id The id of the managed file.
String name The name of the managed file.
String path The relative path of the managed file. In IBM BPM, this is the same as the name.
TWManagedFileTypes Types Returns the types of Managed file.
String url The url which can be used to refer to the file (if type is Web).
Method Summary
String getTypeName() Returns the name of the type.
String readText() Reads the text of the managed file. This assumes that the file is a text file and not binary. If the file is binary, this call will likely fail with a conversion error or possibly succeed and return garbage. This call should be considered for use in high-performance runtime situations. Note: this operation is not recommended for large files as the entire text of the file will be loaded in memory.
void writeDataToFile(String newFileLocation) Saves the data (text or binary) into the given location. This function can be useful when a file needs to be stored on the local server during Installation.

TWManagedFileTypes

Contains constants for managed file types.

Property Summary
String Design Constant to denote files like XSL that can be associated with Coach designer.
String Server Constant to denote files like JAR, JavaScript, etc. that can be used in server side scripts.
String Web Constant to denote files like PNG, JPEG, CSS, HTML, etc. that can be used for UI representation in the browser.

TWModelNamespace

the 'tw.system.model' object contains useful functions to get model objects.

Property Summary
TWEnvironmentNamespace env The env variable namespace.
TWSearchMetaData fullTextSearchMetaData Get the searchable fields available in the search index.
TWProcessApp processApp The current process application.
TWProcessAppSnapshot processAppSnapshot The current process app snapshot.
TWSearchMetaData searchMetaData Information about columns that can be used for searching.
Method Summary
TWManagedFile findManagedFileByPath(String managedFilePath , String managedFileType) Returns a managed file given its file path and the type of managed file, e.g. Web or Server. Starts with the Process App and then looking into its Toolkits.
TWProcess findProcess(String bpdId , String processAppId) Returns the process found by process ID.
TWProcessApp findProcessAppByAcronym(String processAppAcronym) Returns the process app with the given Acronym.
TWProcessApp findProcessAppByID(String processAppID) Returns the process application with the given ID.
TWProcessApp findProcessAppByName(String processAppName) Returns the process application with the given Name.
TWProcess findProcessByName(String processName) Returns the process with the given name.
TWService findServiceByName(String serviceName) Returns the service with the given name.
TWProcessApp[] getAllProcessApps( boolean includeToolkits) Returns a array of all process apps in the system, optionally including Toolkits.
TWProcessApp[] getAllToolkits() Returns all the toolkits in the system.

TWObject

TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object. or object[""].

Property Summary
int arrayLength Deprecated. arr.arrayLength is deprecated. Use arr.listLength instead.
Returns the length of the list properties of this object.
#[] listAllSelected Returns an array of all of the selected items in this array. The items are returned ordered so that the most recently selected item is in position 0 and the least recently selected at the end.
Integer[] listAllSelectedIndices Returns an array of all of the selected indices of this array. The indices are returned ordered so that the most recently selected index is in position 0 and the least recently selected at the end.
int listLength Returns the length of the list properties of this object.
# listSelected Returns the most recently selected item in the array or undefined if there are no selected items.
Integer listSelectedIndex Returns the index of the most recently selected item in the array or -1 if there are no selected indices.
String[] propertyNames Returns the names of the properties defined in this object as an Array.
Method Summary
[init]( String version) Constructor. Example: var v = new tw.object.MyObject();
Array arrayToNativeArray() Deprecated. arrayToNativeArray is Deprecated. Use listToNativeArray instead.
Converts this TWObject array to a Native JavaScript Array object.
XMLElement describe() Returns an xml structure of the properties and structure associated with this object. This is very useful for debugging.
String getTypeName() Returns the name of the type.
void insertIntoArray(int position , Object object) Deprecated. use insertIntoList() instead.
Adds a value to the list in a particular position. The list will be resized to fit the objects.
void insertIntoList(int position , Object object) Adds a value to the list in a particular position. The list will be resized to fit the objects.
boolean isDirty() Returns true if the metadata isDirty flag is set in this TWObject or any contained TWObject.
void listAddSelected(int index) Adds an item from the list of selected items.
void listClearAllSelected() Removes all items from the selection list.
boolean listIsSelected(int index) Returns true if item index is selected, false if not.
void listRemoveSelected(int index) Removes an item from the list of selected items.
Array listToNativeArray() Converts this TWObject array to a Native JavaScript Array object.
void load( String key) Loads the current version of this shared business object from the database. If a key is specified, load the current version of the shared business object defined by the key.
Object metadata(String key) Returns the value of the metadata field for the specified key. (Example: "shared" returns boolean, "key" returns String, "version" returns BigInteger, "isDirty" returns boolean)
void remove(String propertyName) Removes a property from this object.
void removeIndex(int listIndex) Removes a value from the list. The list will be resized to fit the remaining objects.
void save() Persists this shared business object to the database.
String toString() Returns the String representation of the object.
XMLElement toXML() Returns an xml structure of the properties associated with this object.
String toXMLString() Returns an xml structure as String of the properties associated with this object.

TWParticipantGroup

Contains useful methods to access the team.

Property Summary
TWUser[] allUsers Returns a list of all users which are direct or indirect members of the team.
TWRole associatedRole Returns a particpant group's associated role.
String id Returns a particpant group's Id.
String name Returns a particpant group's name.
TWProcessApp processApp Returns a particpant group's process app.
TWRole[] roles Returns a list of roles which are direct members of the team.
TWProcessAppSnapshot snapshot Returns a particpant group's process app.
TWUser[] users Returns a list of users who are direct members of the team.
Method Summary
void addRoles(TWRole roles) Add the roles(s) to the role.
void addUsers(TWUser users) Add the user(s) to the role. Accepts as input (TWUser|TWUser[]|String|String[]).
String getTypeName() Returns the name of the type.
boolean hasUser(TWUser user) Returns true if the user is a member. Accepts a username or a TWUser object.
void refresh() Refresh the associated runtime role membership. Note: this is done automatically with add/remove functions.
void removeRoles(TWRole roles) Remove the roles(s) from the role.
void removeUsers(TWUser users) Remove the user(s) from the role. Accepts as input (TWUser|TWUser[]|String|String[]).

TWProcess

Represents a BPD.

Property Summary
TWObject conditionalActivities Hierarchical list of conditional activities in current BPD.
String description The description of the BPD.
TWSearchMetaData fullTextSearchMetaData Get the searchable fields for a BPD.
String guid The GUID of this business process.
String id The id of the BPD (externalized form of ID).
TWLink[] links The reference links in the documentation.
String name The name of the BPD.
TWProcessPerformanceMetric performanceMetrics Provides access to Process Performance Metric objects which can be accessed as defined in Expose performance metrics.
TWObject*Phase phases The phases/milestones defined for the Process.
TWProcessApp processApp The Process App/Toolkit of the instance.
TWSearchMetaData searchMetaData Information about columns that can be used for searching.
TWObject*Step steps The steps/flow objects defined for the Process.
Method Summary
String getTypeName() Returns the name of the type.
String[] startNew( Map inputParams) Starts a process instance.

TWProcessApp

A Process App/Toolkit object.

Property Summary
String acronym The acronym of the process app or a toolkit.
TWProcessInstance[] activeInstances An array of all active instances of this Snapshot.
TWProcessAppSnapshot currentSnapshot The snapshot of the current process app that is currently being executed or installed.
TWProcessAppSnapshot defaultSnapshot The snapshot of the current process app that is designated as default. When set, this property changes the default snapshot in Process Portal.
String id The identifier (externalized ID) of the process app or toolkit.
boolean isToolkit Returns a Boolean value; true if the process app represents a reusable toolkit, otherwise false.
TWLink[] links The reference links in the documentation.
String name The name of the process app or toolkit.
TWProcessAppSnapshot[] snapshots Returns a JavaScript array of all of the snapshots of the current process app on a Teamworks Process Server or Process Center. If on Process Center, excludes archived snapshots. This list returns the snapshots in the order of oldest to newest based on the snapshot creation date.
Method Summary
TWProcessAppSnapshot findSnapshotByID(String snapshotID) Returns the Snapshot of this Process App by its ID.
TWProcessAppSnapshot findSnapshotByName(String snapshotName) Returns the Snapshot of this Process App by its name.
TWLink[] getLinks( boolean includeReferencedToolkits , function linkFilter) Returns a filtered list of links in the process application. If includeReferencedToolkits is true, the links on the children library elements and on the referenced toolkits elements are also listed. If you do not set includeReferencedToolkits, it defaults to false and returns only the link of the current process application. The linkFilter function acts as a filter to the list of links. The filter function accepts a TWLink parameter and returns a boolean value. If the filter evaluates to true, the link is filtered out. A sample usage of this function is given below: var twFilter = function (twLink) { if (condition on twLink) {return true;} else {return false;} } var links = getLinks (true, twFilter); Note: If the call is done from the context of another process application, only the links of the process application can be obtained. The filtered list will not include any children.
String getTypeName() Returns the name of the type.

TWProcessAppDefaults

Contains the defaults for this version of the Process App/Toolkit.

Property Summary
TWManagedFile coachCSS The default coach CSS.
TWManagedFile coachTransformXSL The default coach designer transform XSL.
TWLink[] links The reference links in the documentation.
Method Summary
String getTypeName() Returns the name of the type.

TWProcessAppSnapshot

A Process Application object.

Property Summary
TWProcessInstance[] activeInstances An array of all active instances of this Snapshot.
TWDate dateCreated The date the Snapshot was created.
TWDate dateInstalled The date the Snapshot was installed.
TWProcessAppDefaults defaultSettings The default Process App/Toolkit settings.
String id The ID of the Snapshot.
boolean isActive Whether or not the Snapshot is active.
TWLink[] links The reference links in the documentation.
String name The name of the Snapshot.
TWProcessApp processApp The Process App/Toolkit of this Snapshot.
Method Summary
void activate() Activates the Process App if it is inactive and it is not a Toolkit, otherwise ignored.
void deactivate() Deactivates the Process App if it is active and it is not a Toolkit, otherwise ignored.
TWManagedFile findManagedFileByPath(String managedFilePath , String managedFileType) Returns a managed file given its file path and the type of managed file, e.g. Web or Server.
TWParticipantGroup findParticipantGroupByName(String participantGroupName) Find a Particpant Group by name.
TWProcess findProcessByName(String processName) Find a BPD by name.
TWService findServiceByName(String snapshotName) Find a Service by name.
TWService findServiceByNameInSnapshot(String snapshotName) Finds a Service by name with respect to the TWProcessAppSnapshot it is called upon.
String getTypeName() Returns the name of the type.

TWProcessInstance

Represents a process instance.

Property Summary
TWAdhocStartingPoint[] adhocStartingPoint A JavaScript array of all ad hoc starting points currently available on the process instance.
TWDate atRiskDate The risk date of the instance.
Map businessData The business data for the instance. Note: If the business data contains a list, and an item of the list is selected, only the selected item is returned. If there is no selected item, the entire list is returned.
TWDocument[] documents A JavaScript array of all documents associated with the instance.
TWDocumentSearchTypes DocumentSearchTypes Contains constant values for possible document search types.
TWDate dueDate The due date.
String id The ID of the instance (externalized form of ID).
boolean isAtRisk Instance status if it is at risk.
TWLink[] links The reference links in the documentation.
String name The name of the instance.
TWProcess process The BPD of the instance.
TWProcessApp processApp The Process App/Toolkit of the instance.
TWObject selectedConditionalActivities List of Conditional Activities that have been selected. Can be null and can be set.
String sharepointSiteURL The SharePoint Site URL.
TWProcessAppSnapshot snapshot The particular snapshot of the instance.
TWDate startDate The creation time of the instance.
String status The current status of the process instance.
TWProcessInstanceStatuses Statuses Types of statuses.
TWTask[] tasks A JavaScript array of all tasks for the instance.
PathStep traversedPath Traversed Path of the instance.
Method Summary
void abort() Aborts the instance.
void addComment(String comment) Adds a comment to the instance.
TWDocument addDocument(String type , String name , String fileLocation , boolean hideInPortal , TWUser createdBy , Map properties) Adds a document to the instance. If the type is File, fileLocation should reference the file on the server, otherwise it should reference the new URI.
TWAdhocStartingPoint findAdhocStartingPointByID(String adhocStartingPointID) Finds an ad hoc activity so that it can be started.
TWAdhocStartingPoint findAdhocStartingPointByName(String adhocStartingPointName) Finds an ad hoc activity so that it can be started.
TWDocument[] findDocuments(Map properties , String searchType) Finds and returns a JavaScript array of documents of the instance that match the given properties.
String[] getAvailableActions( String[] actionsFilter) Returns a list of available actions on the instance for the specified user.
String getTypeName() Returns the name of the type.
void migrateTo(TWProcessAppSnapshot snapshot) Migrates instance to the given Snapshot.
void overrideProjectedPathStep(ProjectedPathLinkChange[] listOfLinkChanges) Change the Path Flow.
void resume() Resumes the instance, whether suspended or in a failed state.
Stream retrieveInstanceStream( String sortOrder , String page , String pageSize , TWDate sinceDateTime , Boolean filterStreamForGantt) Retrieves stream entries for a bpdInstance.
ProjectedPathStep retrieveProjectedPath( String searchFilter , ProjectedPathStepChange[] listofPreviewStepChanges , ProjectedPathTaskChange[] listofPreviewTaskChanges , ProjectedPathLinkChange[] listofPreviewLinkChanges) Based on the Historical Analysis, retrieves the Projected Paths
void sendHelpRequest(String sendTo , String description) Sends a help request to the given user/group.
void suspend() Suspends the instance.
void updateFutureStep(ProjectedPathStepChange[] listOfStepChanges) Update the duedate, priority, duration for the Future steps.
TWProcessInstanceValidation validateMigrationTo(TWProcessAppSnapshot snapshot) Runs Migration validation against the given Snapshot.

TWProcessInstanceStatuses

Constants to represent statuses of TWProcessInstance.

Property Summary
String Active BPD instance is in active state.
String Completed BPD instance has been completed.
String DidNotStart BPD instance has not been started because start message event condition returned false.
String Failed BPD instance failed due to runtime error.
String Suspended BPD instance has been suspended.
String Terminated BPD instance has been terminated.

TWProcessPerformanceMetric

To access the Process Performance Metric objects method the user must have access as defined in Expose performance metrics.

Method Summary
ActivitySummary[] retrieveActivitySummaries( String searchFilter , Boolean checkAuthorization) Returns a list of Activity Summaries for the current bpd.
ChartData retrieveInstanceTrend( String units , Integer numPeriods , String endPeriod , String timezone , String searchFilter , boolean checkAuthorization) Returns a ChartData object composing data series for New Instances and Completed Instances.
ProcessHistoricalStatistics retrieveProcessHistoricalStatistics(ProcessHistoricalStatisticsProperties properties , Boolean checkAuthorization) Retrieves process statistics such as the average instance duration, and optionally statistical data related to the tasks and timing intervals in the process.
ProcessInstanceListItem[] retrieveProcessInstanceList(ProcessInstanceListProperties properties , Boolean checkAuthorization) Returns a List of ProcessInstanceListItem BOs representing the list of process instances matching the filter criteria
ProcessSummary retrieveProcessSummary( String searchFilter , Boolean checkAuthorization) Returns the process summary found by process ID.

TWRelationshipTypes

The link type of a reference link.

Property Summary
String AFFECTED_BY The relationship type Affected By.
String IMPLEMENTS The relationship type Implements.
String RELATED_TO The relationship type Related To.
String RESOLVES The relationship type Resolves.
String USES The relationship type Uses.

TWReport

From this object one can access aspects of the report definition. Deprecated. Use coach-based dashboards instead.

Property Summary
Object epv Deprecated. Use coach-based dashboards instead.
Accessor object for Exposed Process Variables that are associated with the report.
boolean isEmbedded Deprecated. Use coach-based dashboards instead.
Returns a boolean whether a page is embeded in a scoreboard (only valid inside a page).
String name Deprecated. Use coach-based dashboards instead.
The name of the report.
String pageName Deprecated. Use coach-based dashboards instead.
The page name of the current rendered page (only valid inside a page).
Method Summary
String applyFilter(String filterName , String value) Deprecated. Use coach-based dashboards instead.
Sets the value for the filter and returns the new value.
String createPageLink(String reportPageName , String linkText) Deprecated. Use coach-based dashboards instead.
(pageName, linkText) creates HTML where you can click on 'linkText' to get to pageName. If embedded this returns the same as createPageLinkInNewWindow().
String createPageLinkInNewWindow(String reportPagename , String linkText) Deprecated. Use coach-based dashboards instead.
Returns an HTML link to open the given report page in a new window.
String displayDefaultPage() Deprecated. Use coach-based dashboards instead.
Returns the rendered HTML of the default page.
String displayPage(String reportPageName) Deprecated. Use coach-based dashboards instead.
Prepares and returns HTML for the given report page.
TWReport getByName(String reportName) Deprecated. Use coach-based dashboards instead.
Returns a report object given its name.
TWChart getChartInstance(String chartName) Deprecated. Use coach-based dashboards instead.
retrieves a TWChart instance setup after the report chart specifications.
Array getFilterParameters() Deprecated. Use coach-based dashboards instead.
Returns a list of all current parameters.
String getFilterValue(String filterName) Deprecated. Use coach-based dashboards instead.
Returns the filter value.
String getPageId(String reportPageName) Deprecated. Use coach-based dashboards instead.
Returns the given report page ID.
String getPageURL(String reportPageName) Deprecated. Use coach-based dashboards instead.
Returns the URL for the given report page.
String getPortalPageURL(String reportPageName) Deprecated. Use coach-based dashboards instead.
Returns the portal URL for the given report page.
String getTypeName() Deprecated. Use coach-based dashboards instead.
Returns the name of the type.
String linkPageInNewWindowURL() Deprecated. Use coach-based dashboards instead.
Returns a link in another target.
String linkPageURL() Deprecated. Use coach-based dashboards instead.
Returns a link to another report page. If embeded this returns the same as linkPageInNewWindowURL(pageName).
void removeFilterValue(String filterName) Deprecated. Use coach-based dashboards instead.
Removes the filter value. The default will be used.
void setFilterValue(String filterName , String value) Deprecated. Use coach-based dashboards instead.
Sets the filter value.

TWReportFilter

This object exists in Report Filter Layouts only. It is used to give access to runtime and author set values of a report filter.

Property Summary
String content The original content this filter is replacing. In a where clause filter this is generally the actual where clause you want to turn on and off. In replace text filters, this is normally the default value.
String defaultValue The default value given to this filter in the report datasource.
String label The label given to this filter in the report datasource.
String name name of report filter. This is the name used by report.applyFilter(), report.setFilterValue() and report.getFilterValue(). It is set in the report datasource this filter is attached to. Do not confuse this with the name of the layout.
String value The current value as given either from the default value, a manually set report filter value or the HTML page value given to this filter.

TWRole

Contains useful methods to access the Role.

Property Summary
TWObject*TWUser allUsers A JavaScript array of all users of this role, users of its contained roles, etc. This should clean the list so that a user only shows up once no matter how many roles they are in. Also, all users from external security groups should get pulled into this list, regardless of whether they have logged in.
TWObject*TWRole children Deprecated. Use the managedTeamRoles property on the TWRole object
Returns a role's immediate children.
TWObject*TWRole containerRoles Returns a list of roles which this role is a member of.
int id Returns a role's Id.
TWObject*TWRole managedTeamRoles A JavaScript array of teams managed by this role.
String name Returns a role's name.
TWRole parent Deprecated. Use the teamManagerRole property on the TWRole object
Returns a role's parent.
TWObject*TWRole roles Returns a role's role members.
TWRole teamManagerRole Returns the manager role for My Team Performance.
TWObject*TWUser users Returns a role's user members.
Method Summary
void addRoles( TWRole roles , TWRole[] roles , String roles , String[] roles) Add the roles(s) to the role.
void addUsers( TWUser users , TWUser[] users , String users , String[] users) Add the user(s) to the role.
TWRole[] getChildren() Deprecated. use property children
Returns a role's immediate children.
int getId() Deprecated. use property id
Returns a role's Id.
String getName() Deprecated. use property name
Returns a role's name.
TWRole getParent() Deprecated. use property parent
Returns a role's parent.
String getTypeName() Returns the name of the type.
TWUser[] getUsers() Deprecated. use property users
Returns a role's members.
void removeRoles( TWRole roles , TWRole[] roles , String roles , String[] roles) Remove the roles(s).
void removeUsers( TWUser users , TWUser[] users , String users , String[] users) Remove the user(s) from the role.

TWSavedSearch

Represents a saved search object.

Property Summary
String id The id of the saved search.
String name The name of the saved search.
TWSearch search The search object representing the actual search object.
Method Summary
String getTypeName() Returns the name of the type.

TWScoreboard

Represents a scoreboard object. Deprecated. Use coach-based dashboards instead.

Property Summary
String id Deprecated. Use coach-based dashboards instead.
The id of the scoreboard.
String name Deprecated. Use coach-based dashboards instead.
The name of the scoreboard.
String systemID Deprecated. Use coach-based dashboards instead.
The system id of the scoreboard.
String url Deprecated. Use coach-based dashboards instead.
The url of the scoreboard.
Method Summary
String getTypeName() Deprecated. Use coach-based dashboards instead.
Returns the name of the type.

TWSearch

Contains properties and methods for search.

Property Summary
TWSearchColumn[] columns An array of columns to return in the search.
TWSearchCondition[] conditions An array of conditions to use in the search.
TWSearchOptions options Options that change the behavior of the search.
TWSearchOrdering[] orderBy An array of orderings used for the results of the search.
TWSearchOrganizeByTypes OrganizeByTypes Returns the search results organized by constants.
String organizedBy How the search is organized (task or process instance). See TWSearch.OrganizeByTypes for valid constants.
Method Summary
TWSearchResults execute( TWUser | TWRole | String userOrRole , Integer maxRows , Integer beginIndex) Executes this search against the given user or role. If userOrRole is empty or null, the search should execute without filtering. If a filter is used, it should be the same filtering that occurs in the web API (i.e. based on the user and all of their roles, not just the user itself).
TWProcessInstance[] executeForProcessInstances( TWUser | TWRole | String userOrRole , Integer maxRows , Integer beginIndex) Executes this search against the given user or role returning a JavaScript array of process instances. If userOrRole is empty or null, the search should execute without filtering. If a filter is used, it should be the same filtering that occurs in the web API (i.e. based on the user and all of their roles, not just the user itself).
TWTask[] executeForTasks( TWUser | TWRole | String userOrRole , Integer maxRows , Integer beginIndex) Executes this search against the given user or role returning a JavaScript array of tasks. If userOrRole is empty or null, the search should execute without filtering. If a filter is used, it should be the same filtering that occurs in the web API (i.e. based on the user and all of their roles, not just the user itself).
String getTypeName() Returns the name of the type.

TWSearchColumn

Contains properties for search column.

Property Summary
String name Returns name of the column.
TWSearchColumnProcessColumns ProcessColumns Returns the searchable column names for a Process.
TWSearchColumnProcessInstanceColumns ProcessInstanceColumns Returns the searchable column names for a Process Instance.
TWSearchColumnTaskColumns TaskColumns Returns the searchable column names for a Task.
String type Returns the type of search column from TWSearchColumnTypes.Types.
TWSearchColumnTypes Types Returns the search column type constants.
Method Summary
String getTypeName() Returns the name of the type.

TWSearchColumnMetaData

Search column information for returning and querying against columns.

Property Summary
boolean isUsableInSearchCondition Always returns true since any column that is available in search results can also be used as part of a search condition.
String name The name of the column.
String type The column type (one of TWSearchColumn.Types).
String valueType The type of the value for the column (one of TWSearchColumnMetaData.ValueTypes).
TWSearchColumnMetaDataValueTypes ValueTypes A set of constants for the value types of the search metadata.
Method Summary
String getTypeName() Returns the name of the type.

TWSearchColumnMetaDataValueTypes

Value types of the search column metadata.

Property Summary
String Boolean Searchable bussiness data is of type Boolean
String DateTime Searchable bussiness data is of type DateTime
String Decimal Searchable bussiness data is of type Decimal
String Integer Searchable bussiness data is of type Integer
String String Searchable bussiness data is of type String

TWSearchColumnProcessColumns

Contains constants for searchable column names of a Process.

Property Summary
String Name Searching BPD instances or tasks by BPD name.

TWSearchColumnProcessInstanceColumns

Contains constants for searchable column names of a Process Instance.

Property Summary
String DueDate Searching BPD instances or tasks by instance due date.
String ID Searching BPD instances or tasks by instance ID.
String Name Searching BPD instances or tasks by instance name.
String ProcessApp Searching BPD instances or tasks by process application name.
String Snapshot Searching BPD instances or tasks by snapshot name.
String Status Searching BPD instances or tasks by instance status.

TWSearchColumnTaskColumns

Contains constants for searchable column names of a Task.

Property Summary
String Activity Searching BPD instances or tasks by task activity name.
String AssignedToRole Searching BPD instances or tasks by role that task is assigned to.
String AssignedToUser Searching BPD instances or tasks by user that task is assigned to.
String ClosedBy Searching BPD instances or tasks by user who closed the task.
String ClosedDate Searching BPD instances or tasks by date when task was closed.
String DueDate Searching BPD instances or tasks by task due data.
String ID Searching BPD instances or tasks by task ID.
String Priority Searching BPD instances or tasks by task priority.
String ReadDate Searching BPD instances or tasks by date when task was read.
String ReceivedDate Searching BPD instances or tasks by date when task was received.
String ReceivedFrom Searching BPD instances or tasks by user that task was received from. (The user that created the task)
String SentDate Searching BPD instances or tasks by date when task was sent.
String Status Searching BPD instances or tasks by task status.
String Subject Searching BPD instances or tasks by task subject.

TWSearchColumnTypes

Contains constants for search column types operations.

Property Summary
String BusinessData Searching BPD instances or tasks using business data properties in criteria.
String Process Searching BPD instances or tasks using BPD properties in criteria.
String ProcessInstance Searching BPD instances or tasks using instance properties in criteria.
String Task Searching BPD instances or tasks using task properties in criteria.

TWSearchCondition

Contains properties for a search condition.

Property Summary
TWSearchColumn column The search column to apply the condition to.
TWSearchConditionOperations Operations Returns the search results organized by constants.
TWSearchConditionOperations operator The search condition operator.
TWObject value The search column to apply the condition to.
Method Summary
String getTypeName() Returns the name of the type.

TWSearchConditionOperations

Contains constants for search condition operations.

Property Summary
String Contains Searching data should contain specified value.
String Equals Searching data should be equal to specified value.
String GreaterThan Searching data should be greater than specified value.
String LessThan Searching data should be less than specified value.
String NotEquals Searching data should not equal to specified value.
String StartsWith Searching data should start with specified value.

TWSearchMetaData

Used to describe data that can be used to perform searches.

Property Summary
TWSearchColumnMetaData[] columns A JavaScript array of column information that can be used for searching.
Method Summary
String getTypeName() Returns the name of the type.

TWSearchOptions

Wraps several parameters for the behavior of TWSearch into a single object.

Property Summary
boolean isTieBreakerSorting Specifies whether TWSearch sorts the results strictly according to the ordering specified in the query (false) or whether the so-called tie breaker columns are appended to the ordering. The tie breaker columns are: instance id, task due date, task priority ranking, task id.

TWSearchOrdering

Contains properties for search ordering.

Property Summary
TWSearchColumn column Returns the search column the ordering refers to.
String Order Returns the search order.
TWSearchOrderingOrders Orders Returns the search results organized by constants.
Method Summary
String getTypeName() Returns the name of the type.

TWSearchOrderingOrders

Contains constants for search orders operations.

Property Summary
String Ascending Search result is ordered ascendingly.
String Descending Search result is ordered descendingly.

TWSearchOrganizeByTypes

Contains constants for task organized by types.

Property Summary
String ProcessInstance Order by process instance.
String Task Order by Task.

TWSearchResultRow

Search results row object.

Property Summary
TWObject[] values The search results row values.
Method Summary
String getTypeName() Returns the name of the type.

TWSearchResults

Search results object.

Property Summary
TWSearchColumnMetaData[] columns The columns in the results.
TWSearchResultRow[] rows The rows in the results.
Method Summary
String getTypeName() Returns the name of the type.

TWService

Represents an executable service.

Property Summary
String id The ID of the service.
TWLink[] links The reference links in the documentation.
String name The name of the service.
String type The type of the service.
TWServiceTypes Types Returns the types of services.
Method Summary
Map execute( Map inputParams) Executes a service with the given input, returning the output parameters.
String getTypeName() Returns the name of the type.

TWServiceTypes

Constants to represent types of services.

Property Summary
String Ajax Service that can be used in Coach controls that support asynchronous server calls using Ajax.
String GeneralSystem General-purpose service that can be used as a system task.
String Human Service that is designed for user interaction.
String Installation Service that is executed during installation of process application.
String Integration Service that contains integration components for Web Services, Java reflection, etc.
String Rule Service that can be used in decision gateways.

TWTask

Contains useful methods to access the Task.

Property Summary
TWDate activationTime The task state.
TWObject assignedTo The TWUser or TWRole that the task is currently assigned to.
TWDate atRiskDate The task at risk date.
TWDate completionTime The task completion time.
TWDate dueDate The task due date.
String flowObjectId The task flow object id.
String id Returns the task Id.
Boolean isAtRisk The task is at risk status.
String localId Returns the localized Id.
String narrative The task narrative.
String originator The task originator.
String owner The task owner.
String phaseId The task phase id.
TWTaskPriorities Priorities Returns the task priorities constants.
String priority The task priority.
Integer priorityValue The task priority value.
String processActivityDescription The description of the process activity associated with the task.
String processActivityName The name of the process activity associated with the task.
TWProcessInstance processInstance The process instance associated with the task.
TWProcessStepInfo processInstanceStep The step in the parent process instance.
TWDate startDate The task start date.
String state The task state.
String status The task status.
TWTaskStatuses Statuses Returns the task statuses constants.
String subject The task subject.
Map[] transactions The SAP transaction list bound with this task. Each transaction has properties: scope,logicalComponent,standard,object,name,sapId,typeDescription,type
Method Summary
long[] complete(TWUser user , Map outputValues) Completes the task. This is generally used in conjunction with external activities. If autoflow is enabled and next autoflow task is found, it returns ID of that task.
String[] getAvailableActions( String[] actionsFilter) Returns a list of available actions on the task for the specified user.
String getTypeName() Returns the name of the type.
void reassignBackToRole() Reassigns the task to it's original Role.
void reassignTo(TWUser usersOrRoles) Reassigns the task to the given user(s) and/or role(s). Accepts a single TWUser Object.
void reassignTo(TWRole usersOrRoles) Reassigns the task to the given user(s) and/or role(s). Accepts a single TWRole Object.
void reassignTo(TWTeam usersOrRoles) Reassigns the task to the given user(s) and/or role(s). Accepts a single TWTeam Object.
void reassignTo(String usersOrRoles) Reassigns the task to the given user(s) and/or role(s). Accepts a single String that can be comma-delimited. The users and/or roles will be matched by username/role name, roles being matched only if prefixed by "ROLE:" (usernames needn't be prefixed by "USER:" but can be).
void reassignTo(Array usersOrRoles) Reassigns the task to the given user(s) and/or role(s). Accepts a JS array of TWUsers, TWRoles or Strings. The JavaScript array can be filled with any of TWUser, TWRole, TWParticipantGroup or String, so the array could contain a TWUser, a TWRole, and a TWParticpantGroup, for instance.
void reassignTo(String[] usersOrRoles) Reassigns the task to the given user(s) and/or role(s). Accepts a TW list of Strings. The users and/or roles will be matched by username/role name, roles being matched only if prefixed by "ROLE:" (usernames needn't be prefixed by "USER:" but can be).
void start(TWUser user) Starts the task with the given user. This effectively just sets the start time of the task.

TWTaskPriorities

Contains constants for priority types.

Property Summary
String High High Priority.
String Highest Highest Priority.
String Low Low Priority.
String Lowest Lowest Priority.
String Normal Normal Priority.

TWTaskStatuses

Contains constant values for possible statuses.

Property Summary
String Actioned Task is closed.
String Closed Task is closed.
String Deleted Task was deleted.
String Forwarded Task was forwarded.
String New Task was created by and assigned to the current user.
String Received Task was created by and assigned to some user or role.
String Replied Task was replied.
String Sent Task was sent.

TWTeam

Contains useful methods of team.

Property Summary
TWUser[] allUsers Returns a list of all users which are direct or indirect members of the team.
TWRole associatedRole Returns the Role associated with this team.
TeamDashboardSupport dashboard Dashboard coach views support.
String id Id of team.
String name Name of team.
TWProcessApp processApp Process application where team is defined.
TWRole[] roles Returns a list of roles which are direct members of the team.
TWProcessAppSnapshot snapshot Returns the snapshot associated with the team.
TWUser[] users Returns a list of users who are direct members of the team.
Method Summary
void addRoles(TWRole roles) Add the roles(s) to the team.
void addUsers(TWUser users) Add user(s) to the team.
Team asTeam() Converts a TWTeam into a Team business object.
TWTeam getManagerTeam() Returns the manager team of this team.
String getTypeName() Returns the name of the type.
boolean hasUser(TWUser user) Returns true if the user is a member. Accepts a TWUser object.
void refresh() Refresh the associated runtime role membership.
void removeRoles(TWRole roles) Removes role(s) from the team.
void removeUsers(TWUser users) Remove the user(s) from the team.
void setAutomaticRefresh(boolean enable) Sets the enable-automatic-refresh flag for this team.
void setManagerTeam(String teamName) Sets the manager team for this team.

TWTimerInstance

An instance of a timer waiting.

Property Summary
String id The instance ID of the timer.
Method Summary
String getTypeName() Returns the name of the type.

TWUser

Contains useful methods to access the User.

Property Summary
Record attributes Returns all the user's attributes.
UserDashboardSupport dashboard Dashboard coach views support.
String fullName Returns a user's full name.
int id Returns a user's Id.
String name Returns a user's name.
TWObject*TWParticipantGroup participantGroups Returns all the teams the user is a member of.
TWRole primaryRole Deprecated. deprecated
Returns the primary role of the user.
TWRole primaryRoleParent Deprecated. deprecated
Returns the parent of the primary role of the user.
TWObject*TWRole roles Returns all the roles the user is a member of.
TWSavedSearch[] savedSearches An array of all saved portal searches the user has access to.
TWScoreboard[] scoreboards An array of all scoreboards the user has access to.
TWTeam[] teams Returns all the teams the user is a member of.
Method Summary
Map getAttributes() Deprecated. use property attributes
Returns all the user's attributes.
String getFullName() Deprecated. use property fullName
Returns a user's full name.
int getId() Deprecated. use property id
Returns a user's Id.
TWUserLocalePreferences getLocalePreferences(TWUser user) Sets the locale preferences for a user.
String getName() Deprecated. use property name
Returns a user's name.
TWRole getPrimaryRole() Deprecated. use property parimaryRole
Returns the primary role of the user.
TWRole getPrimaryRoleParent() Deprecated. use property primaryRoleParent
Returns the parent of the primary role of the user.
TWRole[] getRoles() Deprecated. use property roles
Returns all the roles the user is a member of.
String getTypeName() Returns the name of the type.
boolean isInParticipantGroup(TWParticipantGroup participantGroup) Tells if the user is a member of the Team.
boolean isInRole( String roleName , TWRole role) Tells if the user is a member of the Role.
boolean isInTeam(TWTeam team) Returns true ifthe user is a member of the given Team.
void removeAttribute(String name) Removes the given attribute and all of its values for this user.
StreamsForUser retrieveUserStream( String sortOrder , String page , String pageSize , TWDate sinceDateTime , String taskId) Retrieves Stream entries for a User.
void setAttributeValue(String name , String value) Set the attribute with the supplied name to the supplied value. The attribute is created if it does not already exist, otherwise its value is replaced. The attribute is in no namespace.
void setLocalePreferences(TWUser user , TWUserLocalePreferences localePreferences) Sets the locale preferences for a user.

TWUserLocalePreferences

Holds information about a user's locale preferences.

Property Summary
String locale Holds a locale in standard format: [_[_variant]]. For example, 'en', 'en_US'.
String localeCountry Returns the country/region code for this locale, which will either be the empty string or an uppercase ISO 3166 2-letter code.
String localeDisplayCountry Returns a name for the locale's country that is appropriate for display to the user.
String localeDisplayLanguage Returns a name for the locale's language that is appropriate for display to the user.
String localeDisplayName Returns a name for the locale that is appropriate for display to the user.
String localeDisplayVariant Returns a name for the locale's variant code that is appropriate for display to the user.
String localeLanguage Returns the language code for this locale, which will either be the empty string or a lowercase ISO 639 code.
String localeVariant Returns the variant code for this locale.

UserDashboardSupport

Dashboard coach views support.

Method Summary
TeamMemberTaskSummary retrieveTeamMemberSummary( String filterString , String timeZoneAsString) Retrieves task status summary for a User.

UserInfo

The User Information.

Property Summary
String fullName The full name of the user.
String name The name of the user.
String userId The user id of the user.

XMLDocument

Represents an XML Document.

Method Summary
XMLElement createElement(String elementName) Create and return a new XMLElement. The newly created XMLElement is not part of the XMLDocument used to create it. Use the insert methods on the correct parent element to add the newly created element in the correct location.
XMLElement getElementByTagName(String tagName) Return the root element of the document if it has the name tagName.
XMLNodeList*XMLElement getElements() Return a list consisting of the single document root element.
String toString( boolean deep) Return a sting representation of the document. If the deep parameter is set to true the whole document is returned as a string, otherwise just the root element is converted and returned.
String transform(String fileName) This function transforms the current document using XSLT. Returns String representation of the result of transformation.
XMLNodeList*XMLElement xpath(String xPathExpression) Apply the provided XPath expression to the document and return the list of Elements selected by the expression. Note that this only returns elements and not other content types.

XMLElement

Represents an XML Element.

Property Summary
XMLNodeList*XMLElement childNodes Return a list of all of the child elements underneath this element.
XMLElement firstChild Return the first child element underneath this element, or null if this element has no children.
XMLElement lastChild Return the last child element underneath this element, or null if this element has no children.
String namespaceURI The namespace URI of this element. This will be the default namespace URI if the element has no prefix.
XMLElement nextSibling Return the next sibling element of this element or null if this element has no next sibling.
XMLDocument ownerDocument Return the document containing this element, or null if the element is not in any document.
XMLElement parentNode Return the parent element of this element or null if this element has no parent, including if it is the root element of its containing document.
XMLElement previousSibling Return the previous sibling of this element or null if this element has no previous sibling.
String tagName Return the name of the current element.
Method Summary
XMLElement appendChild(XMLElement newChild) Append newChild to the end of the list of children of this element. Return newChild.
XMLElement cloneNode( boolean deep) Return a clone of this element. If deep is true children are also cloned recursively.
String getAttribute(String attributeName) Return the value of the attribute with the specified name, or null if there is no such element.
String getAttributeNS(String namespaceURI , String attributeName) Return the value of the attribute identified by the namespaceURI and localName.
XMLNodeList*XMLElement getElementByTagName(String tagName) Returns an XMLNodeList of all child elements of the current element that have the given name. If no child elements have the given name, returns an empty XMLNodeList.
XMLNodeList*XMLElement getElementsByTagNameNS(String namespaceURI , String localName) Return a list of all of the children of the current element that have the specified localName and namespaceURI.
String getText() Return the text contents of the current element, or null if no text.
boolean hasChildNodes() Return true if this element has any child elements.
XMLElement insertBefore(XMLElement newChild , XMLElement refChild) Insert a new element, newChild, as a child of this element before its existing child, refChild. Return newchild.
void removeAttribute(String name) Remove the attribute with the supplied name and no namespace from the element.
void removeAttributeNS(String namespaceURI , String name) Remove the attribute identified by namespaceURI and localName.
XMLElement removeChild(XMLElement oldChild) Remove the child, oldChild, of this element. Return oldChild.
XMLElement replaceChild(XMLElement newChild , XMLElement oldChild) Replace the child, oldChild, of this element with a new child, newChild. Return newChild.
void setAttribute(String name , String value) Set the attribute with the supplied name to the supplied value. The attribute is created if it does not already exist, otherwise its value is replaced. The attribute is in no namespace.
void setAttributeNS(String namespaceURI , String name , String value) Set the value of the attribute identified by namespaceURI and localName to value.
void setText(String text) Set the text contents of the current element to the supplied value, replacing any existing text and/or element content.
String toString( boolean deep) Return a sting representation of the document. If the deep parameter is set to true the whole document is returned as a string, otherwise just the root element is converted and returned.
String transform(String fileName) This function transforms the current document using XSLT. Returns String representation of the result of transformation.NOTE: XSLT only works on documents, so this call assumes that this element is a root element of a document. All XPATHs etc should assume that this is the root.
XMLNodeList*XMLElement xpath(String xPathExpression) Return the list of nodes that are selected by the xpath expression when applied to this element.NOTE: XSLT only works on documents, so this call assumes that this element is a root element of a document. All XPATHs etc should assume that this is the root.

XMLNodeList

Represents a list of XMLElements.

Property Summary
int length The number of items in the list.
Method Summary
XMLElement item(Integer index) The item at position index.

OrgNamespace

the 'tw.system.org' object contains useful methods to access the User Organization.

Property Summary
PGNamespace pg Deprecated. tw.system.org.pg is deprecated. Use tw.system.org.team instead.
The pg namespace contains all teams.
TWSLANamespace sla The sla namespace contains runtime Service Level Agreement statistics.
TeamNamespace team The pg namespace contains all teams.
Method Summary
TWUser[] findAllUsersForRoles(TWRole[] roles) Returns all users that belong to the given roles (Union).
TWUser[] findCommonUsersForRoles(TWRole[] roles) Returns users that only belong to all the given roles (Intersection).
TWParticipantGroup findParticipantGroupByID(String participantId) Finds a Team given its Id.
TWParticipantGroup findParticipantGroupByName(String roleName) Finds a Team given its name.
TWRole findRoleById(String | Integer roleId) Finds a role given their Id.
TWRole findRoleByName(String roleName) Finds a role given their name.
TWTeam findTeam(String teamId , String processAppId) Finds a team, given its id, in any process application.
TWTeam findTeamByID(String teamId) Finds a Team given its Id.
TWTeam findTeamByName(String teamName) Finds a Team given its name.
TWUser findUserById(String | Integer userId) Finds a user given their Id.
TWUser findUserByName(String userName) Finds a user given their name.
TWParticipantGroup[] getAllParticipantGroups() Returns an array of all Teams in the Process App & its Toolkits.
TWRole[] getAllRoles() Returns all roles.
TWTeam[] getAllTeams() Returns all Teams.
TWUser[] getAllUsers() Returns all users.

TWHelpRequest

An instance of a help request.

Property Summary
String id The id of the help request.
Method Summary
void ignore( String comment) Ignore the help request with the given comment.
void reply( String comment) Reply to the help request with the given comment.

TWInstallNamespace

The 'tw.system.install' object contains useful variables and methods about the installation history.

Property Summary
TWProcessAppSnapshot[] snapshotsMigratingInstances A JavaScript array of Snapshots that are having their instances Migrated.
String status Accesses the Installation status.
TWInstallStatusesNamespace Statuses The install namespace containing access to the constant values for the possible statuses.
Method Summary
String getStatusMessage( String locale) Returns the installation status message, localized for the given locale. \nIf locale is not provided, the locale of the current user (or system, if no user) will be used.

TWInstallStatusesNamespace

The 'tw.system.install.Statuses' object contains the constant values for the possible statuses.

Property Summary
String CreatingPackage Creating the Installation package.
String Error General error in Installation.
String InProgress Installation in progress.
String Installed Installation completed.
String MigrationError General error in instance Migration.
String MigrationInProgress Migrateing instances.
String PackageCreated Installation Package is created.
String PartialMigrationError Error Migrateing some instances.
String Scheduled Scheduled to Install at a later date.

TWPerfNamespace

the 'tw.perf' object contains runtime data from the Performance Server

Property Summary
TWSLANamespace sla The sla namespace contains runtime Service Level Agreement statistics

TWServiceClass

The TW Object which is the wrapper around all variables in the system.

Property Summary
TWViewNamespace businessData Description N/A
TWEnvironmentNamespace env The environment namespace contains all environment variables.
TWServiceEpvNamespace epv The epv namespace contains Exposed Process Values attached to this Service.
TWServiceGlobalNamespace global Deprecated. global namespace has been deprecated
The global namespace containing all private, input and output variables.
TWServiceLocalNamespace local The local namespace containing all private, input and output variables.
TWObjectNamespace object The system namespace containing system constants.
TWViewNamespace options Description N/A
TWPerfNamespace perf This is the perf namespace that exposes data from the performance server
TWServiceResourceNamespace resource The resource namespace contains Resource Bundle Groups attaches to this Service.
TWServiceSystemNamespace system The system namespace containing system constants.

TWServiceSystemNamespace

the 'tw.system' object contains useful variables and constants about the system and this particular process.

Property Summary
String buttonPressed Value of the Coach button pressed expression
CoachValidation coachValidation Coach validation object
TWProcess currentProcess Get the Current Process
TWProcessInstance currentProcessInstance Get the Current Process Instance
String currentProcessInstanceID Current BPD Instance Id
TWTask currentTask Get the current task
TWHolidaySchedule defaultHolidaySchedule The system namespace containing the default holiday schedule for the system..
TWTimeSchedule defaultTimeSchedule The system namespace containing the default time schedule for the system..
String defaultTimeZone The system namespace containing the default timezone for the system..
XMLElement error Contains information about the last error
String error_type Contains information about the type of the last error. Possible values are "PRE", "ITEM" and "POST"
TWHeaderNamespace header The system namespace containing access to header information.
TWHolidaySchedule[] holidaySchedules The system namespace containing access to all holiday schedules.
TWInstallNamespace install The system namespace containing access to the installation history information.
TWModelNamespace model Provides access to Model objects.
OrgNamespace org Provides access to the User Organization.
String result Returns data that is exported by the last executed item. In case of Send Task Component\n it returns information about created task.
Serializer serializer Provides serialize/deserialize methods for IBM BPM variables.
String task_id Current task Id
String temporary_directory A variable that contains a temporary directory that can be used to store temporary files.\n It is populated from the configuration system and ends with the file separator character
TWTimeSchedule[] timeSchedules The system namespace containing access to all time schedules.
TWUser user The system namespace containing access to the current User.
String user_fullName Current user full name
String user_id Current user Id
String user_locale Current Java representation of the current user set locale used by I18N support.
String user_localeCountry Deprecated. This property is not used by the new I18N system. Use user_locale.
Current user locale country. These codes are the upper-case two-letter codes as defined by ISO-3166.\n A full list can be obtained from http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html
String user_localeDescription Human readable description of the users locale in his/her local language.
String user_localeLanguage Deprecated. This property is not used by the new I18N system. Use user_locale.
Current user locale language. These codes are the lower-case two-letter codes as defined by ISO-639.\n A full list can be obtained from http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt
String user_loginName Current user login name
String user_timeZone Current user time zone
String user_timeZoneOffset Current user time zone offset
String user_timeZoneOffset Current user time zone offset
Method Summary
void addCoachValidationError(CoachValidation coachValidation , String errorBOPath , String errorMessage) Adds validation error to the instance of CoachValidation type. If error with given BO path is already present, then error message is updated.
boolean addHolidaySchedule(TWHolidaySchedule holidaySchedule) Add a new instance of TWHolidaySchedule which will be included to the list of holiday schedules available in 'tw.system.holidaySchedules'.
boolean addTimeSchedule(TWTimeSchedule timeSchedule) Add a new instance of TWTimeSchedule which will be included to the list of time schedules available in 'tw.system.timeSchedules'.
String[] allVars() Returns Array of all variable names in the Namespace
String bidiTransform(String src , String inputFormat , String outputFormat , boolean symmetricSwapping) Returns the output value of Bidi transformation.
TWDate calculateBusinessDate(TWDate originalDate , Integer delta , String units , TWWorkSchedule workSchedule) Calculate the business date starting with originalDate, changed by the given delta (a negative value means decrease) of the given units (Month, Day, Hour, Minute) according to the given workSchedule.
void clearCoachValidationErrors(CoachValidation coachValidation) Clears all coach validation errors.
String convertIDToDB(String id) Convert a typed external id to an id suitable for use in a database query
void createFromSql(String variableTypeName , String jndiName , String sqlQuery , ANY params) Return the name of the IBM BPM class associated with a variable
void createFromXmlElement(String variableTypeName , Element xml) Returns an array of {variableTypeName} objects containing the data in the given XMLified recordset.
String escapeHtml(String content) Escapes the input string which might contain special characters. This function can be used to avoid potential cross-site scripting (XSS) attacks.
TWProcessInstance executeServiceByName(String name , Map inputValues) Start the Service with the given name.
TWHelpRequest findHelpRequestByID(String id) Find help request by id
TWHolidaySchedule findHolidayScheduleByName(String name) Find TWHolidaySchedule by name in the list of time schedules available in 'tw.system.holidaySchedules'.
TWProcessInstance findProcessInstanceByID(String id) Returns the process found by ID.
TWTask findTaskByID(Integer taskID) Returns the task found by ID.
TWTask findTaskByID(String taskID) Returns the task found by ID.
TWTimeSchedule findTimeScheduleByName(String name) Find TWTimeSchedule by name in the list of time schedules available in 'tw.system.timeSchedules'.
void reassignTask(Integer taskId , String reassignTo , ANY resetTask) Deprecated. reassignTask() has been Deprecated. Use the reassignTo() function in TWTask instead
Reassigns a task to another user or role.
boolean removeCoachValidationError(CoachValidation coachValidation , String errorBOPath) Removes coach validation error with the given business object path
boolean removeHolidaySchedule(String id) Remove TWHolidaySchedule with given id from the list of holiday schedules available in 'tw.system.holidaySchedules'.
boolean removeTimeSchedule(String id) Remove TWTimeSchedule with given id from the list of time schedules available in 'tw.system.timeSchedules'.
void rescheduleTimer(String timerId , TWDate newFireTime) Reschedules a timer.
ProcessSummary[] retrieveProcessSummaries( String searchFilter , Boolean checkAuthorization) Returns a process summary list of all active/deployed processes accross projects.
ProcessSummary[] retrieveProcessSummary(String processAppId , String processId , String searchFilter , Boolean checkAuthorization) Returns the process summary for the specified TWProcess's process ID.
TaskDueData retrieveTaskDueData(TaskDueProperties properties , String timezone) Returns the task due data for a given due date time slice.
TaskListData retrieveTaskList(TaskListProperties properties , Integer maxRows , Integer beginIndex , String timezone) Returns a list of tasks for a given team, team member or user.
TeamTaskSummary[] retrieveTeamSummaries( String searchFilter , String timeZoneAsString , Boolean checkAuthorization) Retrieve summary data of the active tasks of all the Teams.
TWProcessInstance startProcessByName(String name , Map inputValues) Start the BPD with the given name.
String toString() Returns String representation of the namespace
String unescapeHtml(String content) Resolves escaped characters which might exist within the input string, possibly as the result of calling tw.system.escapeHtml(). Returns the un-escaped string.
boolean updateCoachValidationErrorMessage(CoachValidation coachValidation , String errorBOPath , String errorMessage) Updates validation error message for the given business object path.
boolean updateHolidaySchedule(TWHolidaySchedule holidaySchedule) Update instance of TWHolidaySchedule.
boolean updateTimeSchedule(TWTimeSchedule timeSchedule) Update instance of TWTimeSchedule.
String variableTypeForVariable(String fullyQualifiedVariableName) Return the name of the IBM BPM variable type associated with a variable