Parameters in italics are optional.
Namespace | Summary |
---|---|
tw.object | The object namespace is used to initialize complex IBM Business Automation Workflow 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. |
You find a comparison between the BPD namespace and the Service namespace in JavaScript API namespaces.
Namespace | Summary |
---|---|
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. Deprecated. |
TWServiceClass | The TW Object which is the wrapper around all variables in the system. |
TWServiceSystemNamespace | Namespace for accessing and manipulating system data from a service context using 'tw.system'. It contains useful variables and constants about the system and the particular service instance. |
Namespace | Summary |
---|---|
TWBPDPerfNamespace | The 'tw.perf' object used in a process context contains runtime data from the Performance Server. |
TWBPDSystemBPDNamespace | The 'tw.system.bpd' object used in a process context contains useful variables and constants about the system and the particular process instance. |
TWBPDSystemNamespace | Namespace for accessing and manipulating system data from a process context using 'tw.system'. It contains useful variables and constants about the system and the particular process instance. |
TWBPDSystemOrgNamespace | The 'tw.system.org' object used in a process context contains useful methods to access the user organization. |
TWEnvironmentNamespace | Namespace for accessing and manipulating environment variables. |
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. |
TWObjectNamespace | The object namespace is used to initialize complex objects in IBM Business Automation Workflow. |
Object | Summary |
---|---|
ActivityDetails | The object returned by the Activity Details Services. |
ActivityInstance | This object provides properties and methods to work with an activity instance. |
ActivityListData | The object returned by the Activity List Services. |
ActivityListFilter | The object is used as part of the input to the Activity List Services to limit the list of returned activities. |
ActivityListItem | The object representing an activity list item in the ActivityListData object returned by the Activity List Services. |
ActivityListProperties | The object is used as input to the Activity List Services. Use the object to specify sorting or filtering critiera, and enable additional return information. |
ActivitySummary | A list of these objects is returned by the Activity Summary Services. |
AlignTypes | Business object that provides selection options for alignment. |
ANY | This class represents anything in IBM Business Automation Workflow. Use this class to indicate that a variable can be of any type |
Boolean | Boolean Type |
BPMAlertDefinition | The conditions that define when an alert occurs. |
BPMAlertDefinitionStatus | The alert definition status that is returned when the alert definition is evaluated. |
BPMAlertDefinitionStatusResponse | Returns the results of performing a get status operation on multiple alert definitions. |
BPMBOPropertyChange | Contains the old and new values for an updated shared business object |
BPMBOSaveFailedError | Contains a list of validation errors that were raised by a save service for all the shared business objects in an execution context |
BPMBOSaveServiceValidationErrors | Contains a list of validation errors that were raised by a save service for a shared business object |
BPMBOValidationError | Represents a validation error that was raised by a save service for a shared business object |
BPMDocumentDisplayOptions | Specifies the search and display options for documents in the IBM Business Automation Workflow document store. |
BPMDocumentMatchRule | Specifies the match rule when searching for documents in the IBM Business Automation Workflow document store. |
BPMDocumentOptions | Specifies the options for working with documents in the IBM Business Automation Workflow document store. |
BPMDocumentUploadOptions | Specifies the upload options when creating documents in the IBM Business Automation Workflow document store. |
BPMExposedItem | A description of the exposed item. |
BPMFailedOperation | Describes a failed operation during a bulk request. |
BPMRelationship | Description N/A |
BPMRelationshipDetails | Describes a relationship between two instances. This business object is returned by the JavaScript API which creates relationships, and is returned from queries for existing relationships. |
BPMRESTRequest | Represents a REST request. To create a new instance of this object, use "new BPMRESTRequest()" |
BPMRESTResponse | Represents a REST response. |
CaptionHorizontalPositionSelection | Description N/A |
CaptionVerticalPositionSelection | Description N/A |
CaseReference | This object represents a case instance that originated on the IBM Case Manager server. |
ChartClickEvent | ChartClickEvent contains information about the segment of the chart that is clicked, including the series it was a member of and the name and value of the clicked segment. |
ChartData | ChartData is bound directly to the Chart control and contains one or more ChartDataPlot objects. Each ChartDataPlot object is displayed in the chart (overlapping). For example, a chart could display a line plot and a column plot simultaneously. Each chart contains one or more plots, each plot contains one or more series, and each series is made up of one or more data points. |
ChartDataPlot | ChartDataPlot is one or more ChartDataSeries objects that represents plot data. Series in the same plot are displayed alike. For example, two series in a plot displayed as a column chart will each be displayed as sets of columns. |
ChartDataPoint | ChartDataPoint is a single point of data, such as (Apples, 5) or (2013, 637). Each data point is displayed in a plot according to the plot type. For example, a pie chart data point is presented as a pie slice, a column chart data point is presented as a column, a line chart data point is presented as a single dot on a line, and so forth. |
ChartDataSeries | ChartDataSeries represents a series of data points. In column charts, data points of the same series are displayed as columns with the same color. In line charts, each data series is represented by one colored line and each dot on the line represents a data point within the series. The series label is displayed in the chart legend. Because pie plots can only display one series at a time, data point names are displayed in the legend instead. |
ChartDisplayOptions | ChartDisplayOptions is a series of ChartPlotDisplayOptions (one for each ChartDataPlot in ChartData) that gets bound to the Display options configuration setting. |
ChartLegendPositionSelection | ChartLegendPositionSelection determines if the legend is displayed and the position within the chart. The default setting is None (legend is hidden) and the position settings include Left, Right, and Bottom. |
ChartPieLabelSelection | ChartPieLabelSelection determines how pie chart labels are displayed. Settings include None, Numbers, and Percents. |
ChartPlotDisplayOptions | ChartPlotDisplayOptions has attributes that dictate how a plot will be displayed. Each ChartPlotData object in the ChartData object needs a corresponding ChartPlotDisplayOptions object. The plotType attribute is significant because it determines the plot type, such as pie plot or column plot. There are attributes that determine the appearance of a plot axis title and position. For example, a vertical axis could appear flipped on the right side or a horizontal axis could appear flipped at the top. |
ChartPlotType | ChartPlotType includes the following types of plots: pie, bar, column, line, and area. |
ChartThemeSelection | ChartThemeSelection settings are Default, At Risk and Overdue, and Custom. If set to Custom, use the Custom Theme configuration option to define your own theme. |
CMISDocumentOptions | Specifies options for working with Content Management Interoperability Services documents. |
CoachValidation | This object contains coach validation errors. |
CoachValidationError | This object represents CoachValidationError information. |
ConditionalActivity | This object represents a conditional activity in a BPD. |
CurrencyCodeSelectionType | Description N/A |
Date | Date Type |
DateRangeString | This object is used in the TaskListProperties object to specify a date range for which tasks should be returned. |
Decimal | Decimal Type |
DocumentSelection | Specifies the upload options when creating documents in the IBM Business Automation Workflow document store. |
ECMAllowableActions | The list of allowable actions for the object. |
ECMContentEvent | The ECMContentEvent object represents a folder/document event received from an ECM system. |
ECMContentStream | The ECMContentStream object contains the content of an ECM document. |
ECMDocument | The ECMDocument object represents a document in an ECM system. |
ECMDocumentInfo | The ECMDocumentInfo object contains information about an ECM document. |
ECMError | The ECMError object contains information about an exceptional outcome of an ECM operation. |
ECMEventClass | The ECMEventClass object represents the class of an event received from an ECM system (Document or Folder). |
ECMEventType | The ECMEventType object represents the type of an event received from an ECM system. |
ECMFolder | The ECMFolder object represents a folder in an ECM system. |
ECMFolderInfo | The ECMFolderInfo object contains information about an ECM folder. |
ECMID | The ECMID object represents the unique id of an object in an ECM system. |
ECMMultiValue | The ECMMultiValue object contains a value of an ECM property with cardinality=multi. |
ECMObjectTypeDefinition | The ECMObjectTypeDefinition object contains type metadata for ECM folders and ECM documents. |
ECMProperty | The ECMProperty object represents a property of an ECM folder or an ECM document. |
ECMPropertyMetadata | The ECMPropertyMetadata object contains type metadata for properties in an ECM search result set. |
ECMPropertyTypeDefinition | The ECMPropertyTypeDefinition object contains type metadata for properties of Enterprise Content Management (ECM) folders or ECM documents. |
ECMSearchResult | The ECMSearchResult object contains the response of an ECM search operation. |
ECMSearchResultRow | The ECMSearchResultRow object represents a row in an ECM search result set. |
ECMSearchResultSet | The ECMSearchResultSet object represents an ECM search result set. |
ECMServer | Contains information about the defined ECM server. |
ECMServerNames | Server names for use in Content Integration steps. |
IndexedMap | This type contains a list key-value pairs. You can get value for 'theKey' key by following : - by name: myVariable = myIndexedMap.theKey; - by index: myVariable = myIndexMap.data[0] ; , where 0 is an index of the key; |
InstanceListData | The object returned by the Instance List Services. |
InstanceListItem | The object representing a single instance list item that is nested in the InstanceListData object that is returned by the Instance List Services. |
InstanceListProperties | The object is used as input to the Instance List Services to filter or limit the list of returned instances. |
InstanceTasksData | The object that is returned by the Instance Task List Services. |
InstanceTasksFilter | The object is used as part of the input to the Instance Tasks Services to limit the list of returned tasks. |
InstanceTasksProperties | The object is used as input to the Instance Task List Services to filter or limit the list of returned tasks. |
Integer | Integer Type |
IntegrationComponent | This class provides access to IntegrationComponents via JavaScript. |
LayoutTypes | Business object that provides selection options for layout. |
Map | This class represents a Map type in IBM Business Automation Workflow. Use this class to indicate that a variable is of type Map. The only objects that can be assigned to a map are primitives and business objects. |
PathStep | This Object holds the info about traversed path. |
Phase | This object represents the phases or milestones that are defined for the process. |
ProcessHistoricalStatistics | The object that is returned by the Process Historical Statistics Services. |
ProcessHistoricalStatisticsProperties | The object is used as input to the Process Historical Statistics Services. The object properties determine the returned result set. |
ProcessInstanceListItem | A list of these objects is returned by the Process Instance List Services. |
ProcessInstanceListProperties | The object is used as input to the Process Instance List Services to filter or limit the list of returned process instances. |
ProcessSummary | The object that is returned by the Process Summary Services. |
ProjectedPathLinkChange | This object represents a link change that will impact the preview of the projected path. |
ProjectedPathStep | This Object holds the info about projected path. |
ProjectedPathStepChange | The object represents a step change that will impact the preview of the projected path. |
ProjectedPathTaskChange | The object represents a task change that will impact the preview of the projected path. |
RadioButtonsOrientation | Business object that provides selection options for layout. |
Record | This class represents Record type in IBM Business Automation Workflow. Use this class to indicate that a variable is structured type and you don't want to specify all properties or the number of properties is determined at runtime. There is no need to predeclare all properties that will be used. The type of every property will be ANY |
SearchScopeSelection | This object is used by the Search coach view, to allow the selection of a search scope to limit the data labels returned by the Default Auto-completion service, to either Team or Business Process. |
Serializer | Provides serialize/deserialize methods for IBM Business Automation Workflow variables. |
ShowAsSelection | Description N/A |
ShowCalendarSelection | Description N/A |
SLAViolationRecord | The SLAViolationRecord is passed to any BPD being used as the consequence for an SLA in a parameter named "violationRecord" |
SOAPHeader | This objects represents a single SOAP header element that may appear on a web service request or response. |
SOAPHeaders | This type represents the SOAPHeaders which may appear on a web service request or response. |
SQLDatabaseType | This information comes from the JDBC DatabaseMetaData associated with a connection. The properties isDb2, isOracle, and isSqlServer are provided to make it easier to detect the underlying database implementation. Other database types can be determined using the productName property. |
SQLParameter | A SQLParameter is used with a SQLStatement to describe the parameter value, type, and mode information for use with parameterized SQL statements. |
SQLResult | A SQL result can represent a result set, update count, or output values from a stored procedure. The type of result is indicated by the "type" property. RESULT_SET The "columns", "columnIndexes", and "rows" properties are populated with data from the result set. UPDATE_COUNT The "updateCount" property is set to the update count. OUT_VALUES The "outValues" property is set to the list of output values from the stored procedure. |
SQLResultSetColumn | The properties of this type are copied from the JDBC ResultSetMetaData for each column in a result set. |
SQLResultSetRow | A row contains a list of values - one for each column. The values can be any of the IBM Business Automation Workflow simple types. |
SQLStatement | A SQLStatement contains the SQL to execute and its associated parameters (if applicable) and is used with the IBMBPM.SQLConnector APIs. |
Step | A step is a flow object within a BPD diagram. |
Stream | This object holds one or more stream entries. |
StreamActivity | This object holds all the attributes of a stream entry. See the Activity Stream specification for property details: http://activitystrea.ms. |
StreamMediaLink | This object holds simple media attributes such as image, or icon. See the Activity Stream specification for property details: http://activitystrea.ms |
StreamObject | This object holds generic model attributes. See the Activity Stream specification for property details: http://activitystrea.ms |
StreamObjectCollection | This object holds an array of stream objects. See the Activity Stream specification for property details: http://activitystrea.ms |
String | String Type |
TableEditMode | Business object that provides edit mode options for table. |
TableSelectionType | Business object that provides selection options for table. |
TaskAllTimeStatistics | The all time statistics for a task of this type. |
TaskDueData | The object that is returned by the Task Due Services. |
TaskDueProperties | The object is used as input to the Task Due Services to filter or limit the list of returned task due slices. |
TaskDueSummary | The number of tasks in a risk state for a specific time slice. |
TaskHistoricalGanttStatistics | The task historical gantt statistics for a process of this type. |
TaskListData | The object that is returned by the Task List Services. |
TaskListItem | The object that represents a task list item in the TaskListData object returned by the Task List Services. |
TaskListProperties | The object is used as input to the Task List Services to filter or limit the list of returned tasks. |
Team | This object represents a team. |
TeamDashboardSupport | Dashboard coach views support. |
TeamMemberTaskSummary | The object returned by the Team Member Summary Services. |
TeamRosterEntry | A list of these objects is returned by the Team Roster Services. |
TeamTaskSummary | Summary data of a team's active tasks. |
TextAreaType | Business object that provides selection options for TextArea. |
Time | Time Type |
TimingIntervalHistoricalStatistics | The historical statistics for the timing interval for a process of this type. |
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. To create a new instance of this object, use "new TWDate()". The IBM Business Automation Workflow Date type represents a date and a time. For example, 2017-06-15 23:00:00:0. If the IBM Business Automation Workflow server and a user are in different time zones, make sure that the date is adjusted for the user's time zone. Consider the following example: The default time for the Date Time Picker coach view is 12:00 AM. When the user is in the Eastern Standard Time (EST) zone and the server is in the Central Standard Time (CST) zone, the date is returned in CST. As a result, if the user selects June 16, the returned date is June 15 11:00 PM. To return the date in the user's time zone, you must pick the time zone from the user's system rather than from the IBM Business Automation Workflow server. You can accomplish this by using the following format: tw.local.date.format("2017-06-15",tw.system.user_timeZone) |
TWDocument | Represents a document. |
TWDocumentSearchTypes | Constant values for possible document search types. |
TWDocumentTypes | Constant values for document types. |
TWEvent | Represents an event. To create a new instance of this object, use "new TWEvent()". |
TWHolidaySchedule | IBM Business Automation Workflow Variable Type that contains a Holiday Schedule. |
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 Business Automation Workflow. |
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. |
TWObjectContentObject | TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object. |
TWObjectContentObjectActivity | TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object. |
TWObjectContentObjectCase | TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object. |
TWObjectProperty | TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing 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. |
TWProcessInstanceParentCase | Represents a parent case associated with 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. |
TWProcessStepInfo | Gives information about the current process step in the BPD. |
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. Role is used as synonym for group in the JavaScript API. |
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. |
TWTimePeriod | IBM Business Automation Workflow Variable Type that describes a time period (e.g. 7AM-7PM M-F). Note that start and end time are not allowed to have the same value. Otherwise the time period will be ignored as its duration is effectively 0. |
TWTimerInstance | An instance of a timer waiting. |
TWTimeSchedule | IBM Business Automation Workflow Variable Type that describes a time schedule (e.g. 24x7) that covers the period to be used for SLAs |
TWUser | Contains useful methods to access the User. |
TWUserLocalePreferences | Holds information about a user's locale preferences. |
TWWorkSchedule | Transient IBM Business Automation Workflow Variable Type that contains a Time Schedule, Timezone, and Holiday Schedule |
URL | URL Type |
UserDashboardSupport | Dashboard coach views support. |
UserInfo | The user information. |
XMLDocument | This class represents XML Document in IBM Business Automation Workflow. Use this class to indicate that a variable is XML Document |
XMLElement | This class represents XML Element in IBM Business Automation Workflow. Use this class to indicate that a variable is XML Element |
XMLNodeList | This class represents XML Node List in IBM Business Automation Workflow. Use this class to indicate that a variable is XML Node List |
The object returned by the Activity Details Services.
Type | Property | Summary |
---|---|---|
String[]
|
actions
|
Contains the actions specified in the checkActions filter if they are applicable to the activity instance for the current user. If the checkActions filter does not contain any actions, the activity list items are not checked for actions and this property is not set. Valid values are: ACTION_START, ACTION_VIEW. |
String
|
activityType
|
The activity type of the activity instance. Valid values are: USER_TASK, SERVICE_TASK, CALLED_PROCESS and SUB_PROCESS. |
Date
|
dueDate
|
The due date of the activity instance. Optional field. Only applicable to activity instances of the USER_TASK activity type. |
Date
|
endDate
|
The end date of the activity instance. |
String
|
executionState
|
The execution state of the activity instance. Valid values are: READY, WORKING, COMPLETED, WAITING, FAILED, NOT_USED and SKIPPED. |
String
|
executionType
|
The execution type of the activity instance. Valid values are: AUTOMATIC and MANUAL. |
Boolean
|
hidden
|
Indicates whether an activity instance is hidden. |
String
|
id
|
The ID of the activity instance. |
Boolean
|
isPreconditionMatchAll
|
Indicates whether the whole list of precondition expressions must be met or just one of them. Optional field. Only applicable to activity instances with preconditions. |
String
|
name
|
The name of the activity instance. |
String
|
narrative
|
The narrative of the activity instance. |
String
|
optionType
|
The option type of the activity instance specified during modeling. Valid values are: REQUIRED and OPTIONAL. |
String[]
|
preconditionExpressions
|
The expressions that need to be met for the activity to continue. Optional field. Only applicable to activity instances with preconditions. |
String[]
|
preconditionExpressionsDisplay
|
The expressions that must be met for the activity to continue. These expressions are formatted for display in the user interface. Optional field. Only applicable to activity instances with preconditions. |
String[]
|
preconditionTrigger
|
The trigger that need to be met for the activity to continue. Optional field. Only applicable to activity instances with preconditions. |
String
|
preconditionType
|
The type of the precondition the activity must met. Valid values are: NO_PRECONDITION, ANY_DOCUMENT_TYPE, SPECIFIC_DOCUMENT_TYPES, SPECIFIC_VARIABLES, EXPRESSIONS_ONLY. |
Boolean
|
repeatable
|
Indicates whether an activity instance is repeatable. |
Boolean
|
required
|
Indicates whether an activity instance is required for execution of the process. |
Date
|
startDate
|
The start date of the activity instance. |
String
|
taskId
|
The task ID of the task implementation of the activity instance. Optional field. Only applicable to activity instances of the USER_TASK activity type. |
String
|
taskOwnerGroupId
|
The group ID assigned to the task implementation of the activity instance. Optional field. Only applicable to activity instances of the USER_TASK activity type. |
String
|
taskOwnerUserId
|
The user ID assigned to the task implementation of the activity instance. Optional field. Only applicable to activity instances of the USER_TASK activity type. |
This object provides properties and methods to work with an activity instance.
Type | Property | Summary |
---|---|---|
String
|
activityType
|
The type of the activity instance. Valid values are USER_TASK, SERVICE_TASK, CALLED_PROCESS, SUB_PROCESS. |
String
|
enablingDocumentID
|
The ID of the document that enabled the activity instance, if any. |
String
|
enablingDocumentServerName
|
The name of the server that contains the document that enabled the activity instance, if any. |
TWDate
|
endDate
|
The optionType of the activity instance. Valid values are: REQUIRED and OPTIONAL. |
String
|
executionState
|
The state of the activity instance. Valid values are: READY, WORKING, COMPLETED, WAITING, DISABLED, FAILED, NOT_USED and SKIPPED. |
String
|
executionType
|
The executionType of the activity instance. Valid values are: AUTOMATIC and MANUAL. |
Boolean
|
hidden
|
Indicates whether the activity has been defined as hidden during modeling process. |
String
|
id
|
The id of the activity instance. |
String
|
name
|
The name of the activity instance. |
String
|
optionType
|
The optionType of the activity instance. Valid values are: REQUIRED and OPTIONAL. |
Boolean
|
repeatable
|
Indicates, whether an activity instance is repeatable or not. |
Boolean
|
required
|
Indicates, whether an activity instance is required for execution or not. |
TWDate
|
startDate
|
The start date of the activity instance. |
TWTask
|
task
|
The task implementation of the activity instance. Only applicable for activity instance of activity type USER_TASK. |
TWTask[]
|
tasks
|
Returns the related task instance for activity instances with activity type USER_TASK or a list of potentially claimable task instances for activity instances with other activity types. |
Method Summary | |
---|---|
void
|
disable( Boolean
checkAuthorization)
Disables an activity that is in the READY, WAITING, or FAILED state.
|
void
|
enable( Boolean
checkAuthorization)
Enables an activity that is in the DISABLED state.
|
String[]
|
getAvailableActions( String[]
actionsFilter)
Returns a list of available actions on the activity instance for the specified user.
|
void
|
start( String
taskOwnerUserId)
Starts an activity in state READY.
|
ActivityDetails
|
toActivityDetails( String[]
actionsFilter)
Converts the activity instance to an ActivityDetails business object.
|
The object returned by the Activity List Services.
Type | Property | Summary |
---|---|---|
ActivityListItem[]
|
activities
|
A list of ActivityListItem objects. |
The object is used as part of the input to the Activity List Services to limit the list of returned activities.
Type | Property | Summary |
---|---|---|
String[]
|
activityTypeFilter
|
Filter the result list by the specified values. Valid values are: USER_TASK, SERVICE_TASK, CALLED_PROCESS and SUB_PROCESS. Optional field. |
String[]
|
executionStateFilter
|
Filter the result list by the specified values. Valid values are: READY, WORKING, COMPLETED, WAITING, FAILED, NOT_USED and SKIPPED. Optional field. |
String[]
|
executionTypeFilter
|
Filter the result list by the specified values. Valid values are: AUTOMATIC and MANUAL. Optional field. |
String[]
|
optionTypeFilter
|
Filter the result list by the specified values to retrieve activities marked as optional or required during modeling. Valid values are: REQUIRED and OPTIONAL. Optional field. |
String
|
repeatableFilter
|
Filter the result list by the specified values. Valid values are: REPEATABLE and NOT_REPEATABLE. Optional field. |
String
|
requiredFilter
|
Filter the result list by the specified values to retrieve activities optional or required for the completion of the instance. Valid values are: REQUIRED and OPTIONAL. Optional field. |
The object representing an activity list item in the ActivityListData object returned by the Activity List Services.
Type | Property | Summary |
---|---|---|
String[]
|
actions
|
Contains the actions specified in the checkActions filter if they are applicable to the activity list item for the current user. If no action is specified in the checkActions filter, the items are not checked for actions and this property will be empty. Valid values are: ACTION_VIEW_ACTIVITY, ACTION_START_ACTIVITY. |
String
|
activityType
|
The activity type of the activity instance. Valid values are: USER_TASK, SERVICE_TASK, CALLED_PROCESS and SUB_PROCESS. |
String
|
endDate
|
The end date of the activity instance in UTC (ISO date string). |
String
|
executionState
|
The execution state of the activity instance. Valid values are: READY, WORKING, COMPLETED, WAITING, FAILED, NOT_USED and SKIPPED. |
String
|
executionType
|
The execution type of the activity instance. Valid values are: AUTOMATIC and MANUAL. |
Boolean
|
hidden
|
Indicates whether an activity instance is hidden. |
String
|
id
|
The ID of the activity instance. |
String
|
name
|
The name of the activity instance. |
String
|
optionType
|
The option type of the activity instance specified during modeling. Valid values are: REQUIRED and OPTIONAL. |
Boolean
|
repeatable
|
Indicates whether an activity instance is repeatable. |
Boolean
|
required
|
Indicates whether an activity instance is required for the completion of the process. |
String
|
startDate
|
The start date of the activity instance in UTC (ISO date string). |
The object is used as input to the Activity List Services. Use the object to specify sorting or filtering critiera, and enable additional return information.
Type | Property | Summary |
---|---|---|
String[]
|
checkActions
|
Checks whether the defined list of activity actions is applicable to the activity list items for the current user. Valid values are: ACTION_VIEW_ACTIVITY, ACTION_START_ACTIVITY. If no action is defined in checkActions the items won't be checked for actions at all and the actions property in the items will be empty. Optional field. |
ActivityListFilter[]
|
filters
|
The returned activity list items must match at least one of the filters. Optional field. |
String
|
hiddenFilter
|
Filter the result list by the specified value. Valid values are: HIDDEN and NOT_HIDDEN. Optional field. |
String[]
|
sortCriteria
|
Sort the result list by the specified values. Valid values are: STATE_ASC, STATE_DESC, NAME_ASC, NAME_DESC, STARTDATE_ASC, STARTDATE_DESC, OPTIONTYPE_ASC, OPTIONTYPE_DESC. Optional field. Default: NAME_ASC |
A list of these objects is returned by the Activity Summary Services.
Type | 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 the Active state in this activity for the current BPD and process application ID. |
Integer
|
countAtRisk
|
The number of process instances in the At Risk state in this activity for the current BPD and process application ID. |
Integer
|
countOnTrack
|
The number of process instances in the On Track state in this activity for the current BPD and process application ID. |
Integer
|
countOverdue
|
The number of process instances in Overdue state in this activity for the current BPD and process application ID. |
String
|
name
|
The name of the activity for the current BPD and app ID. |
Business object that provides selection options for alignment.
This class represents anything in IBM Business Automation Workflow. Use this class to indicate that a variable can be of any type
Boolean Type
The conditions that define when an alert occurs.
Type | Property | Summary |
---|---|---|
String
|
bpdDisplayName
|
The display name of the selected business process definition in the alert definition. This field is optional and has no impact on the alert definition evaluation. This property and the 'bpdId' property must be from the same business process definition. It is set automatically when the 'bpdId' property is set. |
String
|
bpdId
|
The selected business process definition ID in the alert definition in external string format (for example 25.c904b3b1-afc1-4698-bf5a-a20892c20275). This field is optional unless the property 'bpdDisplayName' is set. The business process definition specified with this property must be related to the project optionally specified in the 'projectId' property and the snapshot optionally specified with the 'snapshotId' property. If a business process definition is not specified, all business process definitions are included by default. |
String
|
category
|
The category of the alert definition. Valid values: INSTANCE and TASK. |
String
|
displayName
|
The display name of the alert definition. |
String
|
id
|
The ID of the alert definition. |
String
|
instanceStatus
|
The selected instance execution status in the alert definition. Valid values: ACTIVE, COMPLETED, FAILED, TERMINATED, and SUSPENDED. Optional field. If not set, all instance execution states are included in the alert definition by default. |
String
|
projectId
|
The selected process application ID in the alert definition in external string format (for example 2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0). This field is optional. It will be set automatically when the properties 'snapshotId' or 'bpdId' are set. If a project is not specified, all projects are included in the alert definition by default. |
String
|
snapshotId
|
The selected snapshot ID in the alert definition in external string format (for example 2064.aaa569e9-a57a-4684-b357-34237e4e49ea). This field is optional. The snapshot specified with this property must be related to the project optionally specified with property 'projectId'. If a snapshot is not specified, all snapshots are included by default. |
String
|
taskStatus
|
The selected task execution status in the alert definition. Valid values are NEW, RECEIVED, and CLOSED. This field is optional. If not set, the alert definition targets all three task execution states. This field is only applicable for alert definitions of type TASK. |
String
|
thresholdOperator
|
The threshold operator in the alert definition. Valid values: LESS, EQUAL, and GREATER. |
String
|
thresholdValue
|
The threshold value in the alert definition. Valid values must be numeric and greater or equal to zero. |
The alert definition status that is returned when the alert definition is evaluated.
Type | Property | Summary |
---|---|---|
String
|
actualValue
|
The actual value at run time for the threshold value set in the alert definition. |
Boolean
|
conditionMet
|
Indicates whether the condition of the alert definition has been met. |
BPMAlertDefinition
|
definition
|
The alert definition evaluated for this alert definition status. |
Returns the results of performing a get status operation on multiple alert definitions.
Type | Property | Summary |
---|---|---|
BPMAlertDefinitionStatus[]
|
alertDefinitionStatus
|
A list of zero or more objects containing the alert definition status. |
BPMFailedOperation[]
|
failedOperations
|
A list of zero or more failed operations. |
Contains the old and new values for an updated shared business object
Type | Property | Summary |
---|---|---|
ANY
|
newValue
|
The new value of the property |
ANY
|
oldValue
|
The old value of the property from the base version |
String
|
property
|
The name of the property that changed in JSON format. Examples: - "name" - "customer.name" - "item[2].amount" |
Contains a list of validation errors that were raised by a save service for all the shared business objects in an execution context
Type | Property | Summary |
---|---|---|
BPMBOSaveServiceValidationErrors[]
|
errors
|
Description N/A |
Contains a list of validation errors that were raised by a save service for a shared business object
Type | Property | Summary |
---|---|---|
ANY
|
object
|
The object that caused a save service to fail because of validation errors. It represents the object after the merge and after the save service made changes to it. |
BPMBOValidationError[]
|
validationErrors
|
The respective output of the shared business object save service |
String
|
variablePath
|
The path to the shared business object in the execution context where the save was performed |
Represents a validation error that was raised by a save service for a shared business object
Type | Property | Summary |
---|---|---|
String
|
errorcode
|
Description N/A |
String
|
errorCode
|
A code that you can use to handle the error programmatically in a BPD or a service |
String
|
errortext
|
Description N/A |
String
|
errorText
|
Message text that can be displayed to users if the error occurs at run time. You can also provide localized versions of the error message |
String
|
property
|
The name of the property in JSON format this validation error is for. Examples: - "name" - "customer.name" - "item[2].amount" |
Specifies the search and display options for documents in the IBM Business Automation Workflow document store.
Type | Property | Summary |
---|---|---|
Boolean
|
associatedWithProcessInstance
|
Description N/A |
BPMDocumentMatchRule
|
displayMatchRule
|
Description N/A |
NameValuePair[]
|
displayProperties
|
Description N/A |
Specifies the match rule when searching for documents in the IBM Business Automation Workflow document store.
Specifies the options for working with documents in the IBM Business Automation Workflow document store.
Type | Property | Summary |
---|---|---|
BPMDocumentDisplayOptions
|
displayOptions
|
Specifies the search and display options for documents in the IBM Business Automation Workflow document store. |
BPMDocumentUploadOptions
|
uploadOptions
|
Specifies the upload options when creating documents in the IBM Business Automation Workflow document store. |
Specifies the upload options when creating documents in the IBM Business Automation Workflow document store.
Type | Property | Summary |
---|---|---|
Boolean
|
addProperties
|
Description N/A |
String
|
defaultUploadName
|
Description N/A |
Boolean
|
hideInPortal
|
Description N/A |
NameValuePair[]
|
uploadProperties
|
Description N/A |
Boolean
|
userEditable
|
Description N/A |
A description of the exposed item.
Type | Property | Summary |
---|---|---|
String
|
branchID
|
The UUID (universally-unique ID)of the branch (or track). |
String
|
branchName
|
The name of the branch (or track). |
String
|
display
|
The name of the exposed item |
String
|
ID
|
The property ID |
boolean
|
isDefault
|
A default property. |
String
|
itemID
|
The UUID (universally-unique ID) of the exposed item |
String
|
itemReference
|
The reference of the exposed item |
String
|
processAppAcronym
|
The acronym of the process application that contains the exposed item. |
String
|
processAppID
|
The UUID (universally-unique ID)of the process application that contains the exposed item |
String
|
processAppName
|
The name of the process application that contains the exposed item. |
String
|
runURL
|
The run URL |
String
|
snapshotCreatedOn
|
The date and time when the snapshot was created. |
String
|
snapshotID
|
The UUID (universally-unique ID)of the snapshot. |
String
|
snapshotName
|
The name of the snapshot. |
String
|
startURL
|
The URL that starts the exposed item. |
boolean
|
tip
|
A boolean value. True if the exposed item is in the top, false if it is in a snapshot |
String
|
topLevelToolkitAcronym
|
If the toolkit is dependent on another toolkit, the acronym of the top level toolkit. |
String
|
topLevelToolkitName
|
If the toolkit is dependent on another toolkit, the acronym of the top level toolkit. |
String
|
type
|
The type of the exposed item. For example, process or service. |
Describes a failed operation during a bulk request.
Type | Property | Summary |
---|---|---|
String
|
errorMessage
|
The error message associated with the error. |
String
|
errorNumber
|
The error message prefix associated with the error. |
String
|
objectId
|
The object ID on which the operation has failed. |
Description N/A
Type | Property | Summary |
---|---|---|
Date
|
creationDate
|
Description N/A |
UserInfo
|
creator
|
Description N/A |
String
|
description
|
Description N/A |
String
|
id
|
Description N/A |
Date
|
lastModified
|
Description N/A |
String
|
sourceId
|
Description N/A |
String
|
targetId
|
Description N/A |
String
|
type
|
Description N/A |
Method Summary | |
---|---|
BPMRelationshipDetails
|
toRelationshipDetails()
Converts the relationship instance to a RelationshipDetails business object.
|
void
|
updateDescription(String
newDescription
,
Boolean
checkAuthorization)
Update the description of the relationship.
|
Describes a relationship between two instances. This business object is returned by the JavaScript API which creates relationships, and is returned from queries for existing relationships.
Type | Property | Summary |
---|---|---|
Date
|
creationDate
|
The date when the relationship was created. |
UserInfo
|
creator
|
The user who created the relationship. |
String
|
description
|
The description of the relationship. |
String
|
id
|
The ID of the relationship. |
Date
|
lastModified
|
The date when the relationship was last modified. |
String
|
sourceId
|
The externalized form of the instance ID of the source, consisting of a type identifier and the instance ID. |
String[]
|
tags
|
Tags that are associated with the relationship. Tags can be used for relationship queries. |
String
|
targetId
|
The externalized form of the instance ID of the target, consisting of a type identifier and the instance ID. |
String
|
type
|
The type of the relationship. It can be one of the following: INDEPENDENT, DEPENDENT. |
Represents a REST request. To create a new instance of this object, use "new BPMRESTRequest()"
Type | Property | Summary |
---|---|---|
String
|
endpointAddress
|
Overwrite the endpoint address. |
String
|
externalServiceName
|
The name of the external service. |
Object
|
httpHeaders
|
Selected REST request headers as a JavaScript object with key-value pairs, for example BPMRESTRequest.httpHeaders={"Content-Type": "application/xml"} |
String
|
httpMethod
|
The type of the operation, for example GET, POST, PUT, DELETE, ... |
String
|
invocationCredential
|
Provide the invocation credentials instead of basic authentication. |
String
|
operationName
|
The name of the operation. |
Object
|
parameters
|
All required parameters as key-value pairs. |
String
|
password
|
Provide the basic authentication password. |
String
|
path
|
The path of the operation. |
Integer
|
requestTimeout
|
Set the time to wait until the request can timeout in milliseconds. |
Integer
|
responseTimeout
|
Set the time to wait until the response can timeout in milliseconds. |
String
|
sslConfiguration
|
The SSL configuration to use. |
String
|
username
|
Provide the basic authentication username. |
Represents a REST response.
Type | Property | Summary |
---|---|---|
String
|
content
|
Content of the response. |
Object
|
httpHeaders
|
Response headers as a JavaScript object with key-value pairs, for example {"Content-Type": "application/xml"}. |
String
|
httpStatusCode
|
The status code of the response. |
String
|
httpStatusMessage
|
The status message of the response. |
Description N/A
Description N/A
This object represents a case instance that originated on the IBM Case Manager server.
Type | Property | Summary |
---|---|---|
String
|
caseFolderId
|
The folder ID of the case instance. |
String
|
caseId
|
The ID of the case instance. |
String
|
caseTitle
|
The title of the case instance. |
ChartClickEvent contains information about the segment of the chart that is clicked, including the series it was a member of and the name and value of the clicked segment.
Type | Property | Summary |
---|---|---|
ChartDataPoint
|
dataPoint
|
Description N/A |
Integer
|
dataPointIndex
|
Description N/A |
String
|
seriesLabel
|
Description N/A |
ChartData is bound directly to the Chart control and contains one or more ChartDataPlot objects. Each ChartDataPlot object is displayed in the chart (overlapping). For example, a chart could display a line plot and a column plot simultaneously. Each chart contains one or more plots, each plot contains one or more series, and each series is made up of one or more data points.
Type | Property | Summary |
---|---|---|
ChartDataPlot[]
|
plots
|
ChartDataPlot is one or more ChartDataSeries objects that represents plot data. Series in the same plot are displayed alike. For example, two series in a plot displayed as a column chart will each be displayed as sets of columns. |
ChartDataPlot is one or more ChartDataSeries objects that represents plot data. Series in the same plot are displayed alike. For example, two series in a plot displayed as a column chart will each be displayed as sets of columns.
Type | Property | Summary |
---|---|---|
ChartDataSeries[]
|
series
|
ChartDataSeries represents a series of data points. In column charts, data points of the same series are displayed as columns with the same color. In line charts, each data series is represented by one colored line and each dot on the line represents a data point within the series. The series label is displayed in the chart legend. Because pie plots can only display one series at a time, data point names are displayed in the legend instead. |
ChartDataPoint is a single point of data, such as (Apples, 5) or (2013, 637). Each data point is displayed in a plot according to the plot type. For example, a pie chart data point is presented as a pie slice, a column chart data point is presented as a column, a line chart data point is presented as a single dot on a line, and so forth.
Type | Property | Summary |
---|---|---|
String
|
name
|
The label for the data point. |
Decimal
|
value
|
The value for the data point. |
ChartDataSeries represents a series of data points. In column charts, data points of the same series are displayed as columns with the same color. In line charts, each data series is represented by one colored line and each dot on the line represents a data point within the series. The series label is displayed in the chart legend. Because pie plots can only display one series at a time, data point names are displayed in the legend instead.
Type | Property | Summary |
---|---|---|
ChartDataPoint[]
|
data
|
ChartDataPoint is a single point of data, such as (Apples, 5) or (2013, 637). Each data point is displayed in a plot according to the plot type. For example, a pie chart data point is presented as a pie slice, a column chart data point is presented as a column, a line chart data point is presented as a single dot on a line, and so forth. |
String
|
label
|
The series label to be displayed in the chart legend. |
ChartDisplayOptions is a series of ChartPlotDisplayOptions (one for each ChartDataPlot in ChartData) that gets bound to the Display options configuration setting.
Type | Property | Summary |
---|---|---|
ChartPlotDisplayOptions[]
|
plots
|
Description N/A |
ChartLegendPositionSelection determines if the legend is displayed and the position within the chart. The default setting is None (legend is hidden) and the position settings include Left, Right, and Bottom.
ChartPieLabelSelection determines how pie chart labels are displayed. Settings include None, Numbers, and Percents.
ChartPlotDisplayOptions has attributes that dictate how a plot will be displayed. Each ChartPlotData object in the ChartData object needs a corresponding ChartPlotDisplayOptions object. The plotType attribute is significant because it determines the plot type, such as pie plot or column plot. There are attributes that determine the appearance of a plot axis title and position. For example, a vertical axis could appear flipped on the right side or a horizontal axis could appear flipped at the top.
Type | Property | Summary |
---|---|---|
Boolean
|
displayHorizontalAxis
|
Description N/A |
Boolean
|
displayHorizontalAxisScrollButtons
|
Description N/A |
Boolean
|
displayVerticalAxis
|
Description N/A |
Boolean
|
flipHorizontalAxisToTop
|
Description N/A |
Boolean
|
flipVerticalAxisToRight
|
Description N/A |
Integer
|
gap
|
Description N/A |
Decimal
|
horizontalAxisMajorTickMarks
|
Description N/A |
Decimal
|
horizontalAxisMinorTickMarks
|
Description N/A |
String
|
horizontalAxisTitle
|
Description N/A |
Decimal
|
horizontalAxisWindowOffset
|
Description N/A |
Boolean
|
horizontalAxisWindowOffsetIsTrailing
|
Description N/A |
Decimal
|
horizontalAxisWindowScale
|
Description N/A |
Integer
|
maxBarSize
|
Description N/A |
Integer
|
minBarSize
|
Description N/A |
ChartPieLabelSelection
|
pieLabels
|
Description N/A |
ChartPlotType
|
plotType
|
Description N/A |
Boolean
|
plotTypeFixed
|
Description N/A |
String
|
tooltipTemplate
|
Description N/A |
Decimal
|
verticalAxisMajorTickMarks
|
Description N/A |
Decimal
|
verticalAxisMinorTickMarks
|
Description N/A |
String
|
verticalAxisTitle
|
Description N/A |
ChartPlotType includes the following types of plots: pie, bar, column, line, and area.
ChartThemeSelection settings are Default, At Risk and Overdue, and Custom. If set to Custom, use the Custom Theme configuration option to define your own theme.
Specifies options for working with Content Management Interoperability Services documents.
Type | Property | Summary |
---|---|---|
String
|
cmisQuery
|
The CMIS query to be executed. |
String
|
parentFolderPath
|
Description N/A |
This object contains coach validation errors.
Type | Property | Summary |
---|---|---|
CoachValidationError[]
|
validationErrors
|
A list of CoachValidationErrors. |
This object represents CoachValidationError information.
Type | Property | Summary |
---|---|---|
String
|
errorBOPath
|
The bo path of the error. |
String
|
errorMessage
|
The error message. |
This object represents a conditional activity in a BPD.
Type | Property | Summary |
---|---|---|
ConditionalActivity[]
|
children
|
A list of child conditional activities to this conditional activity. |
String
|
id
|
The ID of the conditional activity. |
Boolean
|
isConditional
|
Indicates whether the activity is conditional. |
String
|
name
|
The name of the conditional activity. |
Description N/A
Date Type
This object is used in the TaskListProperties object to specify a date range for which tasks should be returned.
Type | Property | Summary |
---|---|---|
String
|
endDate
|
The end date of the date range in UTC (ISO date string). |
String
|
startDate
|
The start date of the date range in UTC (ISO date string). |
Decimal Type
Specifies the upload options when creating documents in the IBM Business Automation Workflow document store.
The list of allowable actions for the object.
Type | Property | Summary |
---|---|---|
Boolean
|
canAddObjectToFolder
|
Can file the object in a folder |
Boolean
|
canApplyACL
|
Can apply Access Control List to this object |
Boolean
|
canApplyPolicy
|
Can apply the specified policy to an object |
Boolean
|
canCancelCheckOut
|
Can cancel the check out the specified private working copy document |
Boolean
|
canCheckIn
|
Can check in the specified private working copy document |
Boolean
|
canCheckOut
|
Can check out the specified document |
Boolean
|
canCreateDocument
|
Can create a document in the specified folder |
Boolean
|
canCreateFolder
|
Can create a folder as a child of the specified folder |
Boolean
|
canCreateRelationship
|
Can create a relationship object with the object as its source |
Boolean
|
canDeleteContentStream
|
Can delete the content stream for the Document object |
Boolean
|
canDeleteObject
|
Can delete the specified object |
Boolean
|
canDeleteTree
|
Can delete the specified folder and all contained objects |
Boolean
|
canGetACL
|
Can get Access Control List of the specified object |
Boolean
|
canGetAllVersions
|
Can get the version series for the Document object |
Boolean
|
canGetAppliedPolicies
|
Can get the list of policies applied to the specified object |
Boolean
|
canGetChildren
|
Can get the children of the folder |
Boolean
|
canGetContentStream
|
Can get the content stream for the document object |
Boolean
|
canGetDescendants
|
Can get the descendants of the folder |
Boolean
|
canGetFolderParent
|
Can get the parent folder of the folder |
Boolean
|
canGetFolderTree
|
Can get the sub-folder tree of the folder |
Boolean
|
canGetObjectParents
|
Can get the parent folders of the object |
Boolean
|
canGetObjectRelationships
|
Can get the relationship in which this object is a source or a target |
Boolean
|
canGetProperties
|
Can read the properties of the specified object |
Boolean
|
canGetRenditions
|
Can retrieve the renditions of this object |
Boolean
|
canMoveObject
|
Can move an object from/into this folder |
Boolean
|
canRemoveObjectFromFolder
|
Can unfile the specified document from a folder |
Boolean
|
canRemovePolicy
|
Can remove a policy from the specified object |
Boolean
|
canSetContentStream
|
Can set the content stream for the document object |
Boolean
|
canUpdateProperties
|
Can update the properties of this object |
The ECMContentEvent object represents a folder/document event received from an ECM system.
Type | Property | Summary |
---|---|---|
ECMEventClass
|
eventClass
|
The ECMEventClass object represents the class of an event received from an ECM system (Document or Folder). |
ECMEventType
|
eventType
|
The ECMEventType object represents the type of an event received from an ECM system. |
ECMID
|
objectId
|
Object identity of the object definition. |
ECMID
|
objectTypeId
|
Object identity of the object type definition. |
ECMEventClass
|
relatedObjectClass
|
Type of the type definition of a related object (Document or Folder), for example, the object filed into a folder. |
ECMID
|
relatedObjectId
|
Object identity of a related object, for example, the object filed into a folder. |
ECMID
|
relatedObjectTypeId
|
Object identity of the type definition of a related object, for example, the object filed into a folder. |
ECMID
|
repositoryId
|
The ECMID of the ECM Repository on the ECM server which sent the event. |
String
|
serverName
|
The name of the ECM server that identifies the corresponding ECM Repository |
The ECMContentStream object contains the content of an ECM document.
Type | Property | Summary |
---|---|---|
ANY
|
content
|
The document content, represented as base64 encoded binary data. |
Integer
|
contentLength
|
Length of the content stream (in bytes) or -1 if the length could not be retrieved. |
String
|
fileName
|
File name of the document content. |
String
|
mimeType
|
MIME type for the document content. |
The ECMDocument object represents a document in an ECM system.
Type | Property | Summary |
---|---|---|
String
|
checkinComment
|
The textual comment associated with the given version. |
String
|
contentURL
|
The location of the document content. |
String
|
createdBy
|
User who created the document. |
Date
|
creationDate
|
Date and time when the folder was created. |
Boolean
|
isLatestMajorVersion
|
True if this document is the latest major version. |
Boolean
|
isLatestVersion
|
True if this document is the latest version. |
Boolean
|
isMajorVersion
|
True if this document a major version. |
Date
|
lastModificationDate
|
Date and time when the document was last modified. |
String
|
lastModifiedBy
|
User who last modified the document. |
String
|
name
|
The name of the Document. |
ECMID
|
objectId
|
Object identity of the document. |
ECMID
|
objectTypeId
|
Object identity of the object type definition. |
ECMProperty[]
|
properties
|
A set of named, but not explicitly ordered, Properties. Within an object, each property is uniquely identified by its property definition id. |
ECMID
|
repositoryId
|
The identifier for the repository hosting the object type definition. |
String
|
serverName
|
The name of the ECM server that identifies the corresponding ECM Repository. |
String
|
versionLabel
|
The version label provided for the version of this document. |
The ECMDocumentInfo object contains information about an ECM document.
Type | Property | Summary |
---|---|---|
String
|
contentURL
|
The location of the document content. |
ECMID
|
objectId
|
Object identity of the document. |
String
|
serverName
|
The name of the ECM server that identifies the corresponding ECM Repository. |
The ECMError object contains information about an exceptional outcome of an ECM operation.
Type | Property | Summary |
---|---|---|
Integer
|
code
|
CMIS exception code. |
String
|
message
|
CMIS exception message text. |
String
|
type
|
CMIS exception type. |
The ECMEventClass object represents the class of an event received from an ECM system (Document or Folder).
The ECMEventType object represents the type of an event received from an ECM system.
The ECMFolder object represents a folder in an ECM system.
Type | Property | Summary |
---|---|---|
String
|
createdBy
|
User who created the folder. |
Date
|
creationDate
|
Date and time when the folder was created. |
Date
|
lastModificationDate
|
Date and time when the object was last modified. |
String
|
lastModifiedBy
|
User who last modified the folder. |
String
|
name
|
The name of the folder. |
ECMID
|
objectId
|
Object identity of the object definition. |
ECMID
|
objectTypeId
|
Object identity of the object type definition. |
ECMID
|
parentId
|
Object identity of the object's immediate parent type. |
String
|
path
|
The fully qualified path to this folder. The root folder has the path "/". |
ECMProperty[]
|
properties
|
A set of named, but not explicitly ordered, Properties. Within an object, each property is uniquely identified by its property definition id. |
ECMID
|
repositoryId
|
The identifier for the repository hosting the object type definition |
String
|
serverName
|
The name of the ECM server that identifies the corresponding ECM Repository. |
ECMFolder[]
|
subFolders
|
The folder objects contained in this folder. May be null (if not requested) or empty (if no sub-folders exist) |
The ECMFolderInfo object contains information about an ECM folder.
Type | Property | Summary |
---|---|---|
String
|
displayName
|
Display name of the folder. |
ECMID
|
objectId
|
Object identity of the folder. |
String
|
serverName
|
The name of the ECM server that identifies the corresponding ECM Repository. |
The ECMID object represents the unique id of an object in an ECM system.
The ECMMultiValue object contains a value of an ECM property with cardinality=multi.
Type | Property | Summary |
---|---|---|
ANY[]
|
value
|
The list of values for an ECM property. |
The ECMObjectTypeDefinition object contains type metadata for ECM folders and ECM documents.
Type | Property | Summary |
---|---|---|
ECMID
|
baseId
|
A value that indicates whether the base type for this object type is the document or folder. |
ECMObjectTypeDefinition[]
|
children
|
Direct subtypes of the object type. (Can be null if not requested by the operation returning an object of this type, or empty if no subtypes exist). |
String
|
description
|
Description of the object type. |
String
|
displayName
|
Display name of the object type. |
String
|
localName
|
Local name of the object type. |
String
|
localNamespace
|
Local namespace of the object type. |
ECMID
|
objectTypeId
|
Object identity of the object type definition. |
ECMID
|
parentId
|
Object identity of the object type's immediate parent type. |
ECMPropertyTypeDefinition[]
|
propertyTypeDefinitions
|
List of property type definitions for this object type definition. (Can be null if not requested by the operation returning an object of this type). |
Boolean
|
queryable
|
Indicates whether the object type can be used for filtering (in the WHERE clause of a search operation). |
String
|
queryName
|
Used for query and filter operations on object types. |
ECMID
|
repositoryId
|
The identifier for the repository hosting the object type definition |
String
|
serverName
|
Name of the ECM server hosting the object type definition. |
The ECMProperty object represents a property of an ECM folder or an ECM document.
Type | Property | Summary |
---|---|---|
ECMID
|
objectTypeId
|
Object identity of the property type definition. |
ANY
|
value
|
The property value. |
The ECMPropertyMetadata object contains type metadata for properties in an ECM search result set.
Type | Property | Summary |
---|---|---|
String
|
displayName
|
Display name of the selected property. |
String
|
queryName
|
Query name of the selected property. |
The ECMPropertyTypeDefinition object contains type metadata for properties of Enterprise Content Management (ECM) folders or ECM documents.
Type | Property | Summary |
---|---|---|
String
|
cardinality
|
Cardinality of the property ("single" or "multi"). |
ANY[]
|
choices
|
Ordered set of single values allowed for this property. |
ANY[]
|
defaultValues
|
The value that the repository set for the property, if a value is not provided by an application when the object is created. The attributes on the default value element are the same as the attributes on the property definition. |
String
|
description
|
Description of the property. |
String
|
displayName
|
Display name of the property. |
String
|
localName
|
Localname of the property. |
String
|
localNamespace
|
Local namespace of the property. |
Decimal
|
maxDecimalValue
|
The maximum value allowed for this property. It is only set if the propertyType is Decimal. |
Integer
|
maxIntegerValue
|
The maximum value allowed for this property. It is only set if the propertyType is Integer. |
Integer
|
maxStringLength
|
The maximum length (in characters) allowed for a value of this property. It is only set if the propertyType is String. |
Decimal
|
minDecimalValue
|
The minimum value allowed for this property. It is only set if the propertyType is Decimal. |
Integer
|
minIntegerValue
|
The minimum value allowed for this property. It is only set if the propertyType is Integer. |
ECMID
|
objectTypeId
|
Object identity of the property type definition. |
Boolean
|
orderable
|
Indicates whether the property can be used for sorting (that is, the property may appear in an ORDER-BY clause of a search operation). |
Integer
|
precisionDecimal
|
The precision in bits supported for values of this property. Valid values for this attribute are: o 32: 32-bit precision (single as specified in IEEE-754-1985). o 64: 64-bit precision (double as specified in IEEE-754-1985). It is only set if the propertyType is Decimal. |
String
|
propertyType
|
This attribute indicates the type of this property. |
Boolean
|
queryable
|
Indicates whether the property can be used for filtering (in the WHERE clause of a search operation). |
String
|
queryName
|
Used for query operations on properties. |
Boolean
|
required
|
Indicates whether a caller (or the repository) must provide a value. |
String
|
resolutionDateTime
|
The precision in bits supported for values of this property. Valid values for this attribute are: o Year: Year resolution is persisted. o Date: Date resolution is persisted. o Time: Time resolution is persisted. It is only set if the propertyType is DateTime. |
String
|
updatability
|
Indicates under what circumstances the property can be updated ("readonly", "readwrite", "whencheckedout", "oncreate"). |
The ECMSearchResult object contains the response of an ECM search operation.
Type | Property | Summary |
---|---|---|
Boolean
|
hasMoreItems
|
More items are available. |
Integer
|
numItems
|
The number of items in the result set before pagination is applied. Note that depending on the ECM server this number may not be accurate. |
ECMID
|
objectTypeId
|
Object identity of the object type definition returned by this search. |
ECMPropertyMetadata[]
|
propertyMetadata
|
Meta data for the selected properties. |
ECMID
|
repositoryId
|
The ECMID of the ECM Repository on the ECM server from which the result was retrieved. |
ANY
|
resultSet
|
The result of the query. |
String
|
serverName
|
The name of the ECM server that identifies the corresponding ECM Repository. |
The ECMSearchResultRow object represents a row in an ECM search result set.
Type | Property | Summary |
---|---|---|
ECMAllowableActions
|
allowableActions
|
The list of allowable Enterprise Content Management actions for the object |
ANY[]
|
column
|
A list of values that is returned by the SQL statement. |
The ECMSearchResultSet object represents an ECM search result set.
Type | Property | Summary |
---|---|---|
ANY[]
|
row
|
A list of values that is returned by the SQL statement. |
Contains information about the defined ECM server.
Type | Property | Summary |
---|---|---|
String
|
contextPath
|
The context path of the server. |
String
|
description
|
The description of the server. |
String
|
eventSourceID
|
The ID of the event source. |
String
|
hostname
|
The hostname of the server. |
String
|
name
|
The name of the server. |
Number
|
port
|
The port of the server. |
String
|
repository
|
The repository of the server. |
String
|
repositoryID
|
The ID of the repository. |
String
|
rootFolderID
|
The ID of the root folder of the server. 'null' is returned if a connection to the server cannot be established. |
Boolean
|
useHTTPS
|
Indicates if the protocol is HTTPS. |
Server names for use in Content Integration steps.
Type | Property | Summary |
---|---|---|
String
|
IBM_BPM_CONTENT_STORE
|
Server name for the IBM Business Automation Workflow content store. |
String
|
IBM_BPM_DOCUMENT_STORE
|
Server name for the IBM Business Automation Workflow document store. |
String
|
IBM_BPM_MANAGED_STORE
|
Server name for the IBM Business Automation Workflow managed store. |
String
|
IBM_BPM_TARGET_STORE
|
Server name for the IBM Business Automation Workflow target store. |
This type contains a list key-value pairs. You can get value for 'theKey' key by following : - by name: myVariable = myIndexedMap.theKey; - by index: myVariable = myIndexMap.data[0] ; , where 0 is an index of the key;
Type | Property | Summary |
---|---|---|
ANY[]
|
data
|
The list holds the values of the keys. |
ANY
|
indexedMap
|
Fake parameter. It is using to add different types and names of properties at run time. |
The object returned by the Instance List Services.
Type | Property | Summary |
---|---|---|
String
|
instanceIndexLastIndexStartTime
|
The date the last index update started in UTC (ISO date string). |
Integer
|
instanceIndexUpdateInterval
|
The number of seconds between instance index updates. |
InstanceListItem[]
|
instances
|
A list of instance list items. |
Integer
|
total
|
The total number of instances in the instance list. |
The object representing a single instance list item that is nested in the InstanceListData object that is returned by the Instance List Services.
Type | Property | Summary |
---|---|---|
String
|
completionDate
|
The completion date of the instance. |
String
|
creationDate
|
The creation date of the instance. |
String
|
dueDate
|
The due date of the instance. |
String
|
id
|
The ID of the instance. |
Boolean
|
isFollowed
|
Indicates whether this instance list item is followed by the current user. |
String
|
name
|
The name of the instance. |
String
|
owningTeamId
|
The ID of the Instance Owners Team of the instance. |
String
|
owningTeamName
|
Description N/A |
String
|
riskState
|
The risk state the instance is in. |
String
|
status
|
The status of the instance. |
The object is used as input to the Instance List Services to filter or limit the list of returned instances.
Type | Property | Summary |
---|---|---|
String
|
searchFilter
|
A Lucene query syntax filter string used to limit the instances that are included. Optional field. |
String[]
|
statusFilter
|
Filter the instance list by the specified values. Optional field. Valid values are: ACTIVE, COMPLETED, FAILED, TERMINATED, DID_NOT_START and SUSPENDED. |
The object that is returned by the Instance Task List Services.
Type | Property | Summary |
---|---|---|
TaskListItem[]
|
tasks
|
A list of tasks. |
Integer
|
total
|
The total number of tasks in the list. |
The object is used as part of the input to the Instance Tasks Services to limit the list of returned tasks.
Type | Property | Summary |
---|---|---|
String[]
|
statusFilter
|
Filter the result list by the specified values. Valid values are: NEW, RECEIVED, REPLIED, FORWARDED, SENT, ACTIONED, CLOSED, SPECIAL, DELETED. Optional field. |
The object is used as input to the Instance Task List Services to filter or limit the list of returned tasks.
Type | Property | Summary |
---|---|---|
String[]
|
checkActions
|
Checks whether the defined list of task actions is applicable to the task list items for the current user. Valid values are: ACTION_CANCELCLAIM, ACTION_CLAIM, ACTION_COMPLETE, ACTION_CREATEMESSAGE, ACTION_GETTASK, ACTION_GETUISETTINGS, ACTION_UPDATEDUEDATE, ACTION_UPDATEPRIORITY, ACTION_REASSIGNTOUSER, ACTION_REASSIGNTOGROUP, ACTION_VIEW_TASK and ACTION_VIEW_TASK_DETAILS. If no action is defined in checkActions the items won't be checked for actions at all and the actions property in the items will be empty. Optional field. |
InstanceTasksFilter[]
|
filters
|
The returned task list items must match at least one of the filters. Optional field. |
String[]
|
sortCriteria
|
Sort the result list by the specified values. Valid values are: DUEDATE_ASC, DUEDATE_DESC, COMPLETEDDATE_ASC, COMPLETEDDATE_DESC, ID_ASC, ID_DESC. You can specify a maximum of three sort values. Optional field. Default: DUEDATE_ASC |
Integer Type
This class provides access to IntegrationComponents via JavaScript.
Type | 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 | |
---|---|
IntegrationComponent
|
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.
|
Business object that provides selection options for layout.
This class represents a Map type in IBM Business Automation Workflow. Use this class to indicate that a variable is of type Map. The only objects that can be assigned to a map are primitives and business objects.
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.
|
This Object holds the info about traversed path.
Type | 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 |
This object represents the phases or milestones that are defined for the process.
Type | Property | Summary |
---|---|---|
String
|
id
|
The ID of the phase or milestone. |
String
|
name
|
The name of the phase or milestone. |
The object that is returned by the Process Historical Statistics Services.
Type | Property | Summary |
---|---|---|
Integer
|
averageInstanceDuration
|
A list of average instance durations for a process of this type. |
TaskAllTimeStatistics[]
|
taskAllTimeStatistics
|
A list of all the 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 historical statistics for the timing interval for a process of this type. |
The object is used as input to the Process Historical Statistics Services. The object properties determine the returned result set.
Type | Property | Summary |
---|---|---|
Boolean
|
includeAllTimeTaskStatistics
|
Controls whether a list of all time task statistics (task minimum and maximum completion times) is returned. Optional field. Default: false. |
Boolean
|
includeAverageInstanceDuration
|
Controls whether a list of average instance durations is returned. Optional field. Default: false. |
Boolean
|
includeGanttTaskStatistics
|
Controls whether a list of Gantt task statistics (average duration, average relative start time, percent executed, activity counter) is returned. Optional field. Default: false. |
Boolean
|
includeTimingIntervalStatistics
|
Controls whether a list of timing interval statistics is returned. Optional field. Default: false. |
String
|
searchFilter
|
Return only entries that contain the specified text. Optional field. |
A list of these objects is returned by the Process Instance List Services.
Type | Property | Summary |
---|---|---|
Integer
|
age
|
The age of the process instance in minutes. |
String
|
dueDate
|
The due date of the process instance. |
Boolean
|
estimatedCompletionDateEnabled
|
Indicates whether '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. |
The object is used as input to the Process Instance List Services to filter or limit the list of returned process instances.
Type | Property | Summary |
---|---|---|
Integer
|
beginIndex
|
Skip the specified number of process instances starting from the top of the result set. Optional field. Default: 0 |
Integer
|
maxRows
|
Limit the number of returned process instances to the specified number. Optional field. Default: 25 |
String
|
riskState
|
Return only process instances that are in the specified state. Valid values are: OnTrack, AtRisk, Overdue. Optional field. If a state is not specified, 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 in the specified step or activity. Optional field. |
String
|
stepRiskState
|
Return only process instances in the step or activity (specified by step ID) that are in the specified risk state. Valid values are: OnTrack, AtRisk, Overdue. Optional field. If a step ID is not specified, all process instances are returned. |
The object that is returned by the Process Summary Services.
Type | Property | Summary |
---|---|---|
Integer
|
countActive
|
The number of active tasks in the process that this summary is for. |
Integer
|
countAtRisk
|
The number of tasks that are at risk in the process that this summary is for. |
Integer
|
countOnTrack
|
The number of tasks that are on track in the process that this summary is for. |
Integer
|
countOverdue
|
The number of tasks overdue in the process that this summary is for. |
String
|
description
|
The description of the process that this summary is for. |
String
|
name
|
The name of the process that this summary is for. |
String
|
processAppId
|
The ID of the process application that this summary is for. |
String
|
processAppName
|
The name of the process application that this summary is for. |
String
|
processId
|
The ID of the process that this summary is for. |
This object represents a link change that will impact the preview of the projected path.
Type | Property | Summary |
---|---|---|
String
|
sourceStep
|
The source step. |
String
|
targetStep
|
The target step. |
This Object holds the info about projected path.
Type | 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. |
The object represents a step change that will impact the preview of the projected path.
Type | Property | Summary |
---|---|---|
Date
|
dueDate
|
The due date of the step. |
Integer
|
duration
|
The duration of the step. |
String
|
id
|
The ID of the step. |
Integer
|
priority
|
The priority of the step. |
The object represents a task change that will impact the preview of the projected path.
Type | Property | Summary |
---|---|---|
Date
|
dueDate
|
The due date of the task. |
String
|
iid
|
The ID of the task. |
Business object that provides selection options for layout.
This class represents Record type in IBM Business Automation Workflow. Use this class to indicate that a variable is structured type and you don't want to specify all properties or the number of properties is determined at runtime. There is no need to predeclare all properties that will be used. The type of every property will be ANY
Type | 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. |
int[]
|
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. |
int
|
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. |
Object[]
|
propertyValues
|
Returns the values 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.
|
Object
|
getPropertyValue(String
name)
Returns the value of the property specified.
|
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
|
removeIndex(int
listIndex)
Removes a value from the list. The list will be resized to fit the remaining objects.
|
void
|
removeProperty(String
propertyName)
Removes a property from this object.
|
void
|
setPropertyValue(String
name
,
Object
value)
Sets the value of a property.
|
String
|
toJSONString( boolean
formatted)
Returns the JSON 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.
|
This object is used by the Search coach view, to allow the selection of a search scope to limit the data labels returned by the Default Auto-completion service, to either Team or Business Process.
Provides serialize/deserialize methods for IBM Business Automation Workflow variables.
Method Summary | |
---|---|
Object
|
fromXml(TWObject
variable)
Deserialize a String or XMLElement object to a IBM Business Automation Workflow variable. The String or XMLElement format should adhere to the format of the serialization using the toXml() API.
|
XMLElement
|
toXml(TWObject
variable)
Serialize an object to XML.
|
Description N/A
Description N/A
‌ Traditional: ‌ The SLAViolationRecord is passed to any BPD being used as the consequence for an SLA in a parameter named "violationRecord"
Type | Property | Summary |
---|---|---|
String
|
slaName
|
The name of the SLA |
Decimal
|
value
|
The value for the SLA at the time it was violated. The meaning of this value is dependent on the SLA |
Decimal
|
violationLevel
|
The violation level of the SLA 0 <= level < 1 means unviolated >=1 means violated |
Date
|
violationTime
|
The time at which the violation occurred |
This objects represents a single SOAP header element that may appear on a web service request or response.
Type | Property | Summary |
---|---|---|
String
|
name
|
The name associated with the SOAP header element. |
String
|
nameSpace
|
The namespace associated with the SOAP header element. |
String
|
value
|
The value of the SOAP header element. This must be a valid XML representation of the complete SOAP header. For example: |
This type represents the SOAPHeaders which may appear on a web service request or response.
Type | Property | Summary |
---|---|---|
SOAPHeader[]
|
headers
|
This object represents a single SOAP header element that can appear on a web service request or response. |
This information comes from the JDBC DatabaseMetaData associated with a connection. The properties isDb2, isOracle, and isSqlServer are provided to make it easier to detect the underlying database implementation. Other database types can be determined using the productName property.
Type | Property | Summary |
---|---|---|
Integer
|
driverMajorVersion
|
The major version number of the used JDBC driver. |
Integer
|
driverMinorVersion
|
The minor version number of the used JDBC driver. |
String
|
driverName
|
The name of the used JDBC driver. |
String
|
driverVersion
|
The version number of the used JDBC driver. |
Boolean
|
isDb2
|
True if the the used database product is DB2. |
Boolean
|
isOracle
|
True if the the used database product is Oracle. |
Boolean
|
isSqlServer
|
True if the the used database product is SqlServer. |
Integer
|
majorVersion
|
The major version of the used database product. |
Integer
|
minorVersion
|
The minor version of the used database product. |
String
|
productName
|
The name of the used database product. |
String
|
productVersion
|
The version number of the used database product. |
A SQLParameter is used with a SQLStatement to describe the parameter value, type, and mode information for use with parameterized SQL statements.
Type | Property | Summary |
---|---|---|
String
|
mode
|
The mode of this parameter. If this is not specified, then the parameter mode defaults to IN. The mode must be specified for OUT or INOUT stored procedure parameters. Modes: IN, INOUT, OUT |
String
|
type
|
The SQL type of this parameter. If the type is not specified for a parameter, then the default behavior of the underlying database driver will be used. Parameter types must be specified when invoking a stored procedure that uses OUT or INOUT parameters. To retrieve a result set from an Oracle stored procedure that has a REF CURSOR output parameter, use the ORACLE_CURSOR type. Note that multi-byte character support on Oracle requires using the special Oracle multi-byte types (ORACLE_NCHAR, etc.), otherwise multi-byte character data may be corrupted. Types can also be specified with precision/scale. This is required when using certain numeric types to avoid truncating the number when the type is used as an INOUT or OUT parameter from a callable statement. Ex: DECIMAL(31,10) Standard JDBC Types: ARRAY, BIGINT, BINARY, BIT, BLOB, BOOLEAN, CHAR, CLOB, DATALINK, DATE, DECIMAL, DISTINCT, DOUBLE, FLOAT, INTEGER, JAVA_OBJECT, LONGVARBINARY, LONGVARCHAR, NULL, NUMERIC, OTHER, REAL, REAL, SMALLINT, STRUCT, TIME, TIMESTAMP, TINYINT, VARBINARY, VARCHAR Oracle Specific Types: ORACLE_TIMESTAMPNS, ORACLE_TIMESTAMPTZ, ORACLE_TIMESTAMPLTZ, ORACLE_INTERVALYM, ORACLE_INTERVALDS, ORACLE_ROWID, ORACLE_CURSOR, ORACLE_BFILE, ORACLE_OPAQUE, ORACLE_JAVA_STRUCT, ORACLE_PLSQL_INDEX_TABLE, ORACLE_BINARY_FLOAT, ORACLE_BINARY_DOUBLE, ORACLE_FIXED_CHAR, ORACLE_NUMBER, ORACLE_RAW Oracle Specific Types for use with Multi-byte Character Data: ORACLE_NCHAR, ORACLE_NVARCHAR, ORACLE_NVARCHAR2, ORACLE_NCLOB DB2 Specific Types: DB2_ROWID, DB2_XML. IBM Business Automation Workflow Product does not transform any complex IBM Business Automation Workflow types (such as TWObjects, Array) to standard JDBC types which can be processed by the database. Only simple types can be handled by the SQL Connector. |
ANY
|
value
|
The value of this parameter. This is required if the parameter mode is IN or INOUT. It is not required for OUT mode parameters. |
A SQL result can represent a result set, update count, or output values from a stored procedure. The type of result is indicated by the "type" property. RESULT_SET The "columns", "columnIndexes", and "rows" properties are populated with data from the result set. UPDATE_COUNT The "updateCount" property is set to the update count. OUT_VALUES The "outValues" property is set to the list of output values from the stored procedure.
Type | Property | Summary |
---|---|---|
Map
|
columnIndexes
|
Map from column name to column index for the result set. |
SQLResultSetColumn[]
|
columns
|
Column meta data for the result set. |
ANY[]
|
outValues
|
Output values from a stored procedures |
IndexedMap[]
|
rows
|
Rows in the result set. |
String
|
type
|
Type of the SQL result object: RESULT_SET, UPDATE_COUNT, OUT_VALUES |
Integer
|
updateCount
|
Number of rows that were updated by the SQL command |
The properties of this type are copied from the JDBC ResultSetMetaData for each column in a result set.
Type | Property | Summary |
---|---|---|
Boolean
|
autoIncrement
|
Indicates whether the designated column is automatically numbered. |
Boolean
|
caseSensitive
|
Indicates whether a column's case matters. |
String
|
catalogName
|
The designated column's table's catalog name. |
String
|
columnClassName
|
The fully-qualified name of the Java class whose instances are manufactured to retrieve a value from the column. |
Integer
|
columnDisplaySize
|
Indicates the designated column's normal maximum width in characters. |
String
|
columnLabel
|
The designated column's suggested title for use in printouts and displays. |
String
|
columnName
|
The designated column's name. |
String
|
columnTypeName
|
The designated column's database-specific type name. |
Boolean
|
currency
|
Indicates whether the designated column is a cash value. |
Boolean
|
definitelyWritable
|
Indicates whether a write on the designated column will definitely succeed. |
Integer
|
nullable
|
Indicates the nullability of values in the designated column. |
Integer
|
precision
|
The designated column's specified column size. |
Boolean
|
readOnly
|
Indicates whether the designated column is definitely not writable. |
Integer
|
scale
|
The designated column's number of digits to right of the decimal point. |
String
|
schemaName
|
The designated column's table's schema. |
Boolean
|
searchable
|
Indicates whether the designated column can be used in a where clause. |
Boolean
|
signed
|
Indicates whether values in the designated column are signed numbers. |
String
|
tableName
|
The designated column's table's name. |
Boolean
|
writable
|
Indicates whether it is possible for a write on the designated column to succeed. |
A row contains a list of values - one for each column. The values can be any of the IBM Business Automation Workflow simple types.
Type | Property | Summary |
---|---|---|
ANY[]
|
data
|
A list of values that is returned by the SQL statement. |
A SQLStatement contains the SQL to execute and its associated parameters (if applicable) and is used with the IBMBPM.SQLConnector APIs.
Type | Property | Summary |
---|---|---|
Integer
|
maxRows
|
(Optional) If specified, the number of rows read from result sets will be limited to the value of this property. Otherwise, all rows will be read. |
SQLParameter[]
|
parameters
|
An SQLParameter is used with an SQLStatement to describe the parameter value, type, and mode information for use with parameterized SQL statements. |
String
|
sql
|
The SQL command (SELECT, INSERT, UPDATE, DELETE, CALL etc.). It considered a best practice to parameterize SQL statements instead of using literal values for parameters. |
A step is a flow object within a BPD diagram.
Type | Property | Summary |
---|---|---|
Integer
|
duration
|
The duration of the step. |
String
|
id
|
The ID of the step. |
String
|
name
|
The name of the step. |
String[]
|
nextSteps
|
A list of next steps. |
String
|
parentBPD
|
The parent BPD of the step. |
String
|
parentStepId
|
The ID of the parent step of the step. |
String
|
phaseId
|
The phase ID of the step. |
String
|
type
|
The type of the step. |
This object holds one or more stream entries.
Type | Property | Summary |
---|---|---|
Boolean
|
more
|
Boolean to indicate if there are additional StreamEntries beyond the current page. |
StreamActivity[]
|
streamActivities
|
The list of StreamActivity entries in the stream page. |
Integer
|
totalItems
|
The number of StreamActivity entries in the stream page. |
This object holds all the attributes of a stream entry. See the Activity Stream specification for property details: http://activitystrea.ms.
Type | Property | Summary |
---|---|---|
StreamObject
|
actor
|
Description N/A |
String
|
content
|
Description N/A |
StreamObject
|
generator
|
Description N/A |
StreamObject
|
ibmbpmext
|
Description N/A |
StreamMediaLink
|
icon
|
Description N/A |
String
|
id
|
Description N/A |
StreamObject
|
object
|
Description N/A |
StreamObject
|
provider
|
Description N/A |
String
|
published
|
Description N/A |
StreamObjectCollection
|
replies
|
Description N/A |
StreamObject
|
target
|
Description N/A |
String
|
title
|
Description N/A |
String
|
updated
|
Description N/A |
String
|
url
|
Description N/A |
String
|
verb
|
Description N/A |
This object holds simple media attributes such as image, or icon. See the Activity Stream specification for property details: http://activitystrea.ms
Type | Property | Summary |
---|---|---|
Integer
|
duration
|
Description N/A |
Integer
|
height
|
Description N/A |
String
|
url
|
Description N/A |
Integer
|
width
|
Description N/A |
This object holds generic model attributes. See the Activity Stream specification for property details: http://activitystrea.ms
Type | Property | Summary |
---|---|---|
StreamObjectCollection
|
attachments
|
Description N/A |
StreamObject
|
author
|
Description N/A |
String
|
content
|
Description N/A |
String
|
displayName
|
Description N/A |
String[]
|
downstreamDuplicates
|
Description N/A |
String
|
fileName
|
Description N/A |
String
|
id
|
Description N/A |
StreamMediaLink
|
image
|
Description N/A |
String
|
objectType
|
Description N/A |
String
|
parent
|
Description N/A |
String
|
processId
|
Description N/A |
String
|
processName
|
Description N/A |
String
|
published
|
Description N/A |
String
|
summary
|
Description N/A |
String
|
taskId
|
Description N/A |
String
|
taskName
|
Description N/A |
String
|
taskText
|
Description N/A |
String
|
updated
|
Description N/A |
String[]
|
upstreamDuplicates
|
Description N/A |
String
|
url
|
Description N/A |
This object holds an array of stream objects. See the Activity Stream specification for property details: http://activitystrea.ms
Type | Property | Summary |
---|---|---|
StreamObject[]
|
items
|
Description N/A |
Integer
|
totalItems
|
Description N/A |
String
|
url
|
Description N/A |
String Type
Business object that provides edit mode options for table.
Business object that provides selection options for table.
The all time statistics for a task of this type.
Type | Property | Summary |
---|---|---|
Integer
|
averageDuration
|
The average duration of the task (in seconds). |
String
|
id
|
The activity ID of the task. |
Integer
|
maximumDuration
|
The maximum duration of the task (in seconds). |
Integer
|
minimumDuration
|
The minimum duration of the task (in seconds). |
String
|
name
|
The activity name of the task. |
The object that is returned by the Task Due Services.
Type | Property | Summary |
---|---|---|
Integer
|
futureCount
|
The number of future tasks for the given time slice. |
Integer
|
oldCount
|
The number of tasks that are older than the specified time slice. |
TaskDueSummary[]
|
taskDueSummaries
|
A list of TaskDueSummary objects (slices). |
String
|
taskIndexLastIndexStartTime
|
The date of the last index start time in UTC (ISO date string). |
Integer
|
taskIndexUpdateInterval
|
The number of seconds between task index updates. |
The object is used as input to the Task Due Services to filter or limit the list of returned task due slices.
Type | Property | Summary |
---|---|---|
String
|
interactionFilter
|
Return only tasks that match the specified 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 that are due before the specified UTC date (ISO 8601 date string). Optional field. If a date is not specified, task due slices for all dates and times are returned. |
String
|
taskDueSelectionStartDate
|
Return only task due slices for tasks that are due after the specified UTC date (ISO 8601 date string). Optional field. If a date is not specified, task due slices for all dates and times are returned. |
String
|
teamId
|
Return only task due slices for tasks that are assigned to the specified team ID. Optional field. If a team ID is not specified, task due slices for all tasks are returned. |
String
|
userId
|
Return only task due slices for tasks that are assigned to the specified user ID. Optional field. If a user ID is not specified, task due slices for all tasks are returned. |
The number of tasks in a risk state for a specific time slice.
Type | Property | Summary |
---|---|---|
Integer
|
atRisk
|
The number of tasks in the specified time slice that are in the At Risk risk state. |
String
|
endDate
|
The end date of the time slice in UTC (ISO 8601 date string). |
Integer
|
onTrack
|
The number of tasks in the specified time slice that are in the On Track risk state. |
Integer
|
overdue
|
The number of tasks in the specified time slice that are in the Overdue risk state. |
String
|
startDate
|
The start date of the time slice in UTC (ISO 8601 date string). |
The task historical gantt statistics for a process of this type.
Type | Property | Summary |
---|---|---|
Integer
|
activityCounter
|
For each process instance, this counter distinguishes the initial activity execution from subsequent executions (rework). |
Integer
|
averageDuration
|
The average task duration (in seconds). |
Integer
|
averageRelativeStartTime
|
The average duration between instance start and task start (in seconds). |
String
|
id
|
ID of the task. |
String
|
name
|
The name of the task. |
Integer
|
percentExecuted
|
A percentage indicating how often this task gets executed relative to instance count. |
The object that is returned by the Task List Services.
Type | Property | Summary |
---|---|---|
UserInfo[]
|
assignedUsers
|
A list of UserInfo objects for users that are assigned to tasks in the list. |
Map
|
riskStateSummary
|
The map contains the number of tasks in the list that are in a specific risk state. Key: risk state; Value: number of tasks in that category. |
String
|
taskIndexLastIndexStartTime
|
The date of the last index start time in UTC (ISO 8601 date string). |
Integer
|
taskIndexUpdateInterval
|
The number of seconds between task index updates. |
TaskListItem[]
|
tasks
|
A list of task list items. |
Integer
|
total
|
The total number of tasks in the list. |
The object that represents a task list item in the TaskListData object returned by the Task List Services.
Type | Property | Summary |
---|---|---|
String[]
|
actions
|
Contains the actions specified in the checkActions filter if they are applicable to the task list item for the current user. If no action is specified in the checkActions filter, the items are not checked for actions and this property will be empty. Valid values are: ACTION_CANCELCLAIM, ACTION_CLAIM, ACTION_COMPLETE, ACTION_CREATEMESSAGE, ACTION_GETTASK, ACTION_GETUISETTINGS, ACTION_UPDATEDUEDATE, ACTION_UPDATEPRIORITY, ACTION_REASSIGNTOUSER, ACTION_REASSIGNTOGROUP, ACTION_VIEW_TASK and ACTION_VIEW_TASK_DETAILS. |
String
|
assignedToTeamId
|
The team ID of the team that the task is assigned to. |
String
|
assignedToTeamName
|
The name of the team that the task is assigned to. |
String
|
assignedToUserFullName
|
The full name of the user that the task is assigned to. |
String
|
assignedToUserId
|
The user ID of the user that 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. |
Integer
|
priority
|
The priority of the task. |
String
|
processInstanceId
|
The ID of the process instance that the task belongs to. |
String
|
processInstanceName
|
The name of the process instance that the task belongs to. |
String
|
riskState
|
The risk state that the task is in. |
String
|
subject
|
The subject of the task. |
The object is used as input to the Task List Services to filter or limit the list of returned tasks.
Type | Property | Summary |
---|---|---|
String[]
|
collapsedRiskStates
|
Return only tasks that are in the specified states. Valid values are: Overdue, AtRisk, DueToday, DueTomorrow, DueThisWeek, DueLater. Optional field. If a state is not specified, all task 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 |
String
|
interactionFilter
|
Return only tasks that match the specified 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. WORK_ON: Work on tasks. This implies the retrieval of tasks which are already claimed. Tasks contained in suspended process instances are excluded. ASSESS_AVAILABLE: Assess available tasks. This implies the retrieval of tasks which can be claimed. Tasks contained in suspended process instances are excluded. ASSESS_AND_WORK_ON: Assess and work on tasks. This implies the retrieval of tasks as implied by the WORK_ON or the ASSESS_AVAILABLE filter values. CHECK_COMPLETED: Work on tasks. This implies the retrieval of completed tasks which are claimed. |
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. |
This object represents a team.
Type | Property | Summary |
---|---|---|
String
|
managerTeam
|
The team managing this team. |
String[]
|
members
|
A list of members in the team. |
String
|
name
|
The name of the team. |
Dashboard coach views support.
Method Summary | |
---|---|
TWObject*TeamRosterEntry
|
retrieveTeamMemberList( String
timezone
,
Boolean
checkAuthorization)
Retrieves the list of team members of this team, as well as their open and completed task counts. 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.
|
The object returned by the Team Member Summary Services.
Type | 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. |
A list of these objects is returned by the Team Roster Services.
Type | 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 that the team member completed today. |
Integer
|
totalOpenTasks
|
The number of open tasks for the team member. |
String
|
userId
|
The user ID of the team member. |
Summary data of a team's active tasks.
Type | 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 ID of the process application that contains the team. |
String
|
processAppName
|
The name of the process application that contains the team. |
Integer
|
tasksCompletedToday
|
The number of tasks completed today for the team. |
String
|
teamId
|
The team ID of the team. |
Integer
|
totalOpenTasks
|
The total number of open tasks for the team. |
Business object that provides selection options for TextArea.
Time Type
The historical statistics for the timing interval for a process of this type.
Type | Property | Summary |
---|---|---|
Integer
|
averageDuration
|
Average timing interval duration (in seconds). |
String
|
id
|
The ID of the timing interval. |
String
|
name
|
The name of the timing interval. |
Represent an adhoc starting point.
Type | 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.
|
The reference link asset type.
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. |
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.
Type | 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, |
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. |
Represents a date. To create a new instance of this object, use "new TWDate()". The IBM Business Automation Workflow Date type represents a date and a time. For example, 2017-06-15 23:00:00:0. If the IBM Business Automation Workflow server and a user are in different time zones, make sure that the date is adjusted for the user's time zone. Consider the following example: The default time for the Date Time Picker coach view is 12:00 AM. When the user is in the Eastern Standard Time (EST) zone and the server is in the Central Standard Time (CST) zone, the date is returned in CST. As a result, if the user selects June 16, the returned date is June 15 11:00 PM. To return the date in the user's time zone, you must pick the time zone from the user's system rather than from the IBM Business Automation Workflow server. You can accomplish this by using the following format: tw.local.date.format("2017-06-15",tw.system.user_timeZone)
Method Summary | |
---|---|
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.
|
String
|
getTimeString()
This method returns an String value representing the number of milliseconds since midnight 01/01/1970 for the specified date.
|
int
|
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.
|
String
|
getUTCTimeString()
This method returns an String value representing the number of milliseconds since midnight 01/01/1970 UTC for the specified date.
|
void
|
parse(String
dateAsString
,
String
formatString
,
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 (Exapmle: "PST", "GMT-8:00", "America/Los_Angeles"). The optional localeString must be a valid locale designation according to the rules in java.util.Locale (Exapmle: "en-US", "fr-CA").
|
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
|
setTimeFromString(String
timeInString)
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.
|
void
|
setUTCTimeFromString(String
timeInString)
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.
|
Represents a document.
Type | Property | Summary |
---|---|---|
TWDocument[]
|
allVersions
|
Returns an array containing all versions of the document. |
String
|
contentType
|
Returns the content type of the document. |
String
|
ecmId
|
Returns the ECM identifier of the document that can be used to perform Content Integration steps in services. |
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
,
Boolean
checkAuthorization)
Adds a new version of the document of the specified type (either TWDocument.Types.File or TWDocument.Types.URL) with the specified file name (and optionally the specified user). The created document version is returned.
|
void
|
deleteAllVersions( Boolean
checkAuthorization)
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.
|
Constant values for possible document search types.
Type | 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. |
Constant values for document types.
Type | Property | Summary |
---|---|---|
String
|
File
|
The document represents a file. |
String
|
URL
|
The document represents a URL. |
Represents an event. To create a new instance of this object, use "new TWEvent()".
Method Summary | |
---|---|
void
|
send()
Method to send an event.
|
int
|
setFactory(String
factory)
Method to set the factory for the event.
|
void
|
setSnapshotName(String
snapshotName)
Method to set the snapshot name for the event.
|
void
|
setURL(String
url)
Method to set the url for the event.
|
IBM Business Automation Workflow Variable Type that contains a Holiday Schedule.
Type | Property | Summary |
---|---|---|
Date[]
|
dates
|
List of Dates that are considered holidays |
String
|
id
|
The ID of the holiday schedule |
String
|
name
|
The name of the holiday schedule |
A Reference link in a documentation section.
Type | 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. |
The reference link type.
Type | Property | Summary |
---|---|---|
String
|
FILE
|
The file link type. |
String
|
OSLC
|
The OSLC link type. |
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 Business Automation Workflow.
Type | 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.
|
Represents a managed file for a particular snapshot of a Process App/Toolkit.
Type | 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 Business Automation Workflow, 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.
|
Contains constants for managed file types.
Type | 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. |
The 'tw.system.model' object contains useful functions to get model objects.
Type | 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 can have a number of attributes and properties depending on its setup. They can all be accessed by doing object.
Type | Property | Summary |
---|---|---|
int
|
arrayLength
|
Deprecated. arr.arrayLength is deprecated. Use arr.listLength instead. Returns the length of the list properties of this object. |
int
|
length
|
Deprecated. arr.length 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. |
int[]
|
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. |
int
|
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. |
Object[]
|
propertyValues
|
Returns the values 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.
|
Object
|
getPropertyValue(String
name)
Returns the value of the property specified.
|
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. You cannot use a key parameter to load a shared business object for a case folder.
|
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
|
removeIndex(int
listIndex)
Removes a value from the list. The list will be resized to fit the remaining objects.
|
void
|
removeProperty(String
propertyName)
Removes a property from this object.
|
void
|
save()
Persists this shared business object to the database.
|
void
|
setPropertyValue(String
name
,
Object
value)
Sets the value of a property.
|
String
|
toJSONString( boolean
formatted)
Returns the JSON representation of the object.
|
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.
|
TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object.
TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object.
TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object.
TWObject can have a number of attributes and properties depending on its setup. They can all be accessed by doing object.
Contains useful methods to access the team.
Type | Property | Summary |
---|---|---|
TWUser[]
|
allUsers
|
Returns a list of all users which are direct or indirect members of the team. |
TWRole
|
associatedRole
|
Returns a participant group's associated role. |
String
|
id
|
Returns a participant group's Id. |
String
|
name
|
Returns a participant group's name. |
TWProcessApp
|
processApp
|
Returns a participant group's process app. |
TWRole[]
|
roles
|
Returns a list of roles which are direct members of the team. |
TWProcessAppSnapshot
|
snapshot
|
Returns a participant 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 to the role. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
void
|
addUsers(TWUser
users)
Add the users to the role. Accepts TWUser, TWUser[], String and String[] as input. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
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 from the role. With IBM BPM V8.5.7. cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
void
|
removeUsers(TWUser
users)
Remove the users from the role. Accepts TWUser, TWUser[], String and String[] as input. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
Represents a BPD.
Type | Property | Summary |
---|---|---|
TWObject*ConditionalActivity
|
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.
|
BPMExposedItem[]
|
retrieveExposedProcesses()
Retrieves a list of available exposed processes.
|
TWProcessInstance
|
startNew( Map
inputParams
,
Boolean
checkAuthorization)
Starts a process instance.
|
A Process App/Toolkit object.
Type | 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
|
findSnapshotByAcronym(String
snapshotAcronym)
Returns the Snapshot of this Process App by its acronym.
|
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.
|
Contains the defaults for this version of the Process App/Toolkit.
Type | 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.
|
A Process Application object.
Type | Property | Summary |
---|---|---|
String
|
acronym
|
The acronym of the snapshot. |
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. In a Process Center environment, calling on the current (tip) snapshot returns null. |
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 Participant 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.
|
TWTeam
|
findTeamByName(String
teamName)
Finds a Team given its name.
|
ECMServer[]
|
getECMServers( Boolean
checkAuthorization)
Obtain a list of all servers with type 'ECM' for the current snapshot.
|
String[]
|
getEnvironmentVariableNames()
Obtain a list of names of environment variables defined in the current snapshot.
|
String
|
getTypeName()
Returns the name of the type.
|
Represents a process instance.
Type | Property | Summary |
---|---|---|
TWAdhocStartingPoint[]
|
adhocStartingPoints
|
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. |
String
|
caseFolderId
|
Deprecated. Use processInstanceFolderId instead. The ID of the case folder associated with the process instance. |
String
|
caseFolderServerName
|
Deprecated. Use processInstanceFolderServerName instead. The name of the server associated with the process instance. |
TWDate
|
closeDatetime
|
The close date. |
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. |
TWDate
|
lastModifiedDatetime
|
The last modified date. |
TWLink[]
|
links
|
The reference links in the documentation. |
String
|
name
|
The name of the instance. |
TWProcessInstanceParentCase
|
parentCase
|
The parent case associated with the instance. |
TWProcess
|
process
|
The BPD of the instance. |
TWProcessApp
|
processApp
|
The Process App/Toolkit of the instance. |
String
|
processInstanceFolderId
|
The ID of the case folder associated with the process instance. |
String
|
processInstanceFolderServerName
|
The name of the server associated with the process instance case folder. |
String[]
|
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
|
startingDocumentId
|
The ID of the document that was causing the start of the instance. |
String
|
startingDocumentServerName
|
The name of the server associated with 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. |
String
|
workflowApplication
|
The workflow application associated with the instance. |
Method Summary | |
---|---|
void
|
abort()
Aborts the instance. Note: Do not use this method if you want to abort the running instance it is being invoked from. Use a 'Terminate End Event' node instead.
|
void
|
addComment(String
comment)
Adds a comment to the instance.
|
BPMRelationship
|
addDependencyOnProcess(String
processInstanceId
,
String
description
,
Boolean
checkAuthorization)
Adds a dependent relationship where the current instance becomes dependent on the instance that is passed into the method. This relationship prevents completion of the current process instance until the instance that it depends on completes.
|
BPMRelationship
|
addDependentProcess(String
processInstanceId
,
String
description
,
Boolean
checkAuthorization)
Adds a dependent relationship where the instance that is passed into the method becomes dependent on the current process instance. This relationship prevents completion of the dependent process instance until the current process instance completes.
|
TWDocument
|
addDocument(String
type
,
String
name
,
String
fileLocation
,
boolean
hideInPortal
,
TWUser
createdBy
,
Map
properties
,
Boolean
checkAuthorization)
Adds a document to the instance. If the type is TWDocument.Types.File, fileLocation should reference the file on the server, otherwise it should reference the URL. The created document is returned.
|
BPMRelationship
|
addRelatedProcess(String
processInstanceId
,
String
description
,
Boolean
checkAuthorization)
Adds an independent relationship between the current instance and the instance that is passed into the method. Returns a scriptable Relationship object.
|
String
|
createCase(String
caseType
,
Record
caseProperties
,
String[]
caseStructure)
Creates a new instance of a case for the specified case type. Returns the ID of the new case.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
String
|
createCaseUsingSpecifiedCaseType(String
caseType
,
String[]
casePropertyNames
,
String[]
casePropertyValues
,
String[]
caseStructure)
Creates a new instance of a case for the specified case type. Returns the ID of the new case.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
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.
|
TWProcessInstance[]
|
getDependedOnProcesses( Boolean
checkAuthorization
,
String[]
statusFilter)
Returns a list of process instances on which the current process instance is dependent.
|
TWProcessInstance
|
getDependentProcess( Boolean
checkAuthorization)
Returns a process instance that is dependent on the current process instance.
|
TWProcessInstance[]
|
getRelatedProcesses( Boolean
checkAuthorization
,
String[]
statusFilter)
Returns a list of process instances that have independent relationships with the current process instance.
|
BPMRelationship[]
|
getRelationships( Boolean
checkAuthorization)
Returns a list of relationships associated with the process instance.
|
String
|
getRepositoryName(String
serverId)
Retrieves the repository name for the matching server
|
String
|
getTypeName()
Returns the name of the type.
|
void
|
migrateTo(TWProcessAppSnapshot
snapshot)
Migrates an instance to the specified snapshot. This method is deprecated. Use migrateWithContextTo instead.
|
void
|
migrateWithContextTo(TWProcessAppSnapshot
snapshot)
Migrates an instance and its context to the specified snapshot. Using this method has the same effect as migrating inflight data from the Process Admin console.
|
void
|
migrateWithPolicyTo(TWProcessAppSnapshot
targetSnapshot
,
String
policyFileUrl)
Migrates an instance and its context to the specified snapshot and applies orphaned token policy file. Using this method has the same effect as migrating inflight data from the Process Admin console.
|
void
|
overrideProjectedPathStep(ProjectedPathLinkChange[]
listOfLinkChanges)
Change the projected path for the instance based on a new set of steps.
|
void
|
removeDependedOnProcessRelationship(String
processInstanceId
,
Boolean
checkAuthorization)
Removes the dependent relationship between the current instance and the instance that it depends on.
|
void
|
removeDependentProcessRelationship(String
processInstanceId
,
Boolean
checkAuthorization)
Removes the dependent relationship between the current instance and the dependent instance.
|
void
|
removeRelatedProcessRelationship(String
processInstanceId
,
Boolean
checkAuthorization)
Removes the independent relationship between the current instance and the instance that is passed into the method.
|
void
|
resetAtRiskDate()
Resets the at risk date of the instance and resumes to the automatic at risk calculation.
|
void
|
resume()
Resumes the instance, whether suspended or in a failed state.
|
ActivityListData
|
retrieveActivityList(ActivityListProperties
properties
,
Integer
maxRows
,
Integer
beginIndex
,
Boolean
checkAuthorization)
Returns a list of activities according to the given properties.
|
Stream
|
retrieveInstanceStream( String
sortOrder
,
String
page
,
String
pageSize
,
TWDate
sinceDateTime
,
Boolean
filterStreamForGantt)
Retrieves stream entries for a bpd instance.
|
ProjectedPathStep
|
retrieveProjectedPath( String
searchFilter
,
ProjectedPathStepChange[]
listofPreviewStepChanges
,
ProjectedPathTaskChange[]
listofPreviewTaskChanges
,
ProjectedPathLinkChange[]
listofPreviewLinkChanges)
Retrieves the projected path for the instance.
|
InstanceTasksData
|
retrieveTaskList(InstanceTasksProperties
properties
,
Integer
maxRows
,
Integer
beginIndex
,
String
timezone
,
Boolean
checkAuthorization)
Returns a list of tasks.
|
void
|
sendHelpRequest(String
sendTo
,
String
description)
Sends a help request to the given user/group.
|
void
|
setOwners( String
groupId
,
String
teamName
,
Boolean
checkAuth)
Set the process instance owners. Specify either groupId or teamName.
|
void
|
suspend()
Suspends the instance.
|
void
|
updateFutureStep(ProjectedPathStepChange[]
listOfStepChanges)
Update the expected duedate, priority, or duration for a set of future steps.
|
Represents a parent case associated with a process instance.
Type | Property | Summary |
---|---|---|
String
|
caseId
|
The parent case ID associated with the instance. |
String
|
caseServerId
|
The ID of the server associated with the parent case instance. The ID is not intended to be displayed to end users. |
String
|
parentActivityId
|
The parent activity ID associated with the process instance. |
Method Summary | |
---|---|
String
|
addCommentToCase(String
comment)
Adds a comment to the parent case. Returns the GUID of the new comment.
|
String
|
addCommentToParentActivity(String
comment)
Adds a comment to the parent activity in the parent case. Returns the GUID of the new comment.
|
String
|
completeCurrentStage()
Completes the parent case stage and advances to the next case stage if there is a next case stage. Returns the name of the next case stage, which is the new parent case stage. If there is no next case stage, the string contains 'CmAcmComplete'.
|
void
|
createCasePackage(String
casePackageName
,
Map
packagingOptions)
Creates a package that contains the case artifacts that are specified by the packaging options, and stores the package in the case folder.
|
String
|
createCaseUsingSameCaseType(String[]
casePropertyNames
,
String[]
casePropertyValues
,
String[]
caseStructure)
Creates a new instance of case using the same case type. Returns the ID of the new case.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
void
|
createDefaultCasePackage(String
casePackageName)
Creates a package that contains all case-related artifacts and stores the package in the case folder.
|
String
|
createDiscretionaryActivity(String
discretionaryActivityName)
Creates a new activity instance of a discretionary activity type. The discretionary activity must be defined in the same solution. Returns the ID of the new activity.
|
String
|
createDiscretionaryActivityWithProps(String
discretionaryActivityName
,
String[]
activityPropertyNames
,
String[]
activityPropertyValues
,
String[]
processInputNames
,
String[]
processInputValues)
Creates a new activity instance of a discretionary activity type with the specified properties. Returns the GUID of the new activity.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
String
|
createSubfolder(String
subfolderPath)
Creates a subfolder under the parent case folder. Returns the new subfolder identifier.
|
String
|
disableSpecifiedCaseStage(String
stageId)
Disables the specified case stage from the list of defined case stages. Returns the name of the next case stage if the specified case stage is disabled successfully. Returns an empty string if a case stage can not be disabled successfully.
|
String
|
executeRule(String
ruleName
,
String[]
parameterNames
,
String[]
parameterValues)
Runs a business rule for the current case.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
void
|
fileDocumentInCase(String
documentId
,
String
subFolderPath)
Files a document to a specified subfolder under the current case.
|
String
|
getCaseCalendarEvents()
Returns a JSON string of all the calendar events defined on a case. If there is no calendar events defined in the case, an empty string is returned.
|
String[]
|
getCasePropertyNames()
Returns a list of the symbolic names of the properties in a case (unique identifiers).
|
String[]
|
getCasePropertyValues(String[]
casePropertyNames)
Returns a list of the property values of the parent case. You can use the values that are returned by this function to set values for a new case.
If the new case is not of the same case type as you specify for this function, the property names and values might not match. Values can only be matched for case properties that are shared between the two case types.
Values for case properties that are not shared are blank in the new case.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
String[]
|
getCaseStructure()
Returns the case structure for a given case. The structure is returned as a list of folder names and document series IDs, but excludes any empty folders.
Typically, this function is called to obtain the case structure prior to calling the createCase functions.
The CaseStructure value is a list of strings, containing the case structure as strings of the form 'folder_path/=doc_version_series_ID'.
|
String
|
getCurrentStage()
Returns the name of the current parent case stage. If there is no stage defined in the case, an empty string is returned. If all stages are completed in the case, the string 'CmAcmComplete' is returned.
|
String[]
|
getParentActivityPropertyNames()
Returns a list of property symbolic names (unique identifiers) of an activity.
|
String[]
|
getParentActivityPropertyValues(String[]
activityPropertyNames)
Returns a list of activity property values for a given list of activity property names.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
String
|
placeCurrentStageOnHold()
Puts the current parent case stage on hold and returns the name of the current parent case stage.
|
String
|
relateCase(String
relateTargetId
,
String
relateDescription
,
String
relationshipCategory
,
Boolean
twoWayRelationship)
Creates a relationship between the parent working case and the targeted case. Returns the identifier of the new relationship.
|
String
|
releaseCurrentOnHoldStage()
Releases the hold on the current parent case stage and returns the name of the current parent case stage.
|
String
|
restartPreviousStage()
Restarts the previous parent case stage and returns the name of the previous case stage (which is the new parent case stage). If there is no previous case stage, the string contains the name of the current case stage.
|
String[]
|
searchActivities( String[]
activityTypes
,
String
propertyFilter)
Searches for activities in a particular case by using the provided conditions. Returns a list of activity IDs matching the conditions.
|
void
|
setCasePropertyValues(String[]
casePropertyNames
,
String[]
casePropertyValues)
Sets the values for the specified case properties in the parent case.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
void
|
setParentActivityPropertyValues(String[]
activityPropertyNames
,
String[]
activityPropertyValues)
Sets the activity property values for a particular activity. This method typically applies when updating the activity properties on an activity other than the parent activity.
For the parent activity, you can use step parameters to set the activity properties.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
void
|
terminateActivities()
Terminates all workflows (activities) in the parent case. Activities are terminated only if they have not completed and have not failed. Note: This function can only be called from a service flow, not a process.
|
void
|
unrelateCase(String
relationshipId
,
String
unrelateDescription)
Removes the specified relationship to the parent case.
|
Constants to represent statuses of TWProcessInstance.
Type | 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. |
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 counts for the current bpd.
|
Gives information about the current process step in the BPD.
Type | Property | Summary |
---|---|---|
int
|
counter
|
The counter in a multi instance. Only available within a multi-instance step. |
XMLElement
|
error
|
The error message from an exception. Only on post of exception events. |
String
|
guid
|
The current step GUID. |
int
|
id
|
The current step ID. |
boolean
|
isConditionalActivitySelected
|
Whether or not the current activity is selected if it's a conditional activity. If it's not a conditional activity, this will always be true. |
TWLink[]
|
links
|
Description N/A |
String
|
name
|
The current step name. |
TWProcessInstance
|
processInstance
|
The parent process instance. |
TWTask
|
task
|
The attached task activity. Only available within the post of task activity and events attached to task activities. |
String
|
taskId
|
Deprecated. true The task legacy id of the attached task activity. Only available within the post of task activity and events attached to task activities. |
TWTimerInstance
|
timer
|
The current timer. This property is only valid for timer events. |
String
|
timerId
|
Deprecated. true The current timer legacy id. This property is only valid for timer events. |
Method Summary | |
---|---|
String
|
getTypeName()
Returns the name of the type.
|
The link type of a reference link.
Type | 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. |
From this object one can access aspects of the report definition. Deprecated. Use coach-based dashboards instead.
Type | 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 embedded 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 embedded 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. |
This object exists in Report Filter Layouts only. It is used to give access to runtime and author set values of a report filter.
Type | 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. |
Contains useful methods to access the Role. Role is used as synonym for group in the JavaScript API.
Type | 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
|
If the role does not represent an LDAP group, the role's role members are returned. Otherwise it returns an empty array. |
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 role to the role. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
void
|
addUsers( TWUser
users
,
TWUser[]
users
,
String
users
,
String[]
users)
Add the users to the role. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
TWRole[]
|
getChildren()
Deprecated. use property childrenReturns a role's immediate children. |
int
|
getId()
Deprecated. use property idReturns a role's Id. |
String
|
getName()
Deprecated. use property nameReturns a role's name. |
TWRole
|
getParent()
Deprecated. use property parentReturns a role's parent. |
String
|
getTypeName()
Returns the name of the type.
|
TWUser[]
|
getUsers()
Deprecated. use property usersReturns a role's members. |
void
|
remove( Boolean
checkAuthorization)
Delete a TWRole object of the internal group type. Note: You can't delete a group that has tasks assigned or is configured as bpmAdminGroup in the BPMServerSecurityGroups configuration.
|
void
|
removeRoles( TWRole
roles
,
TWRole[]
roles
,
String
roles
,
String[]
roles)
Remove the roles. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
void
|
removeUsers( TWUser
users
,
TWUser[]
users
,
String
users
,
String[]
users)
Remove the users from the role. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
Represents a saved search object.
Type | 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.
|
Represents a scoreboard object. Deprecated. Use coach-based dashboards instead.
Type | 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. |
Contains properties and methods for search.
Type | 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
| TWParticipantGroup
| String
userOrGroup
,
Integer
maxRows
,
Integer
beginIndex)
Runs this search against the specified user or participant group. Similar to the web API, filters are based on the user as well as all of the user's roles. When userOrRole is empty or null, the search runs with no filters. The maxRows parameter limits the number of search results returned (up to 2,147,483,647). The beginIndex parameter is used in conjunction with maxRows to partition the search results.
|
TWProcessInstance[]
|
executeForProcessInstances( TWUser
| TWParticipantGroup
| String
userOrGroup
,
Integer
maxRows
,
Integer
beginIndex)
Runs this search against the specified user or participant group that returns a JavaScript array of process instances. Similar to the web API, filters are based on the user as well as all of the user's roles. When userOrRole is empty or null, the search runs with no filters. The maxRows parameter limits the number of search results returned (up to 2,147,483,647). The beginIndex parameter is used in conjunction with maxRows to partition the search results.
|
TWTask[]
|
executeForTasks( TWUser
| TWParticipantGroup
| String
userOrGroup
,
Integer
maxRows
,
Integer
beginIndex)
Runs this search against the specified user or participant group that returns a JavaScript array of tasks. Similar to the web API, filters are based on the user as well as all of the user's roles. When userOrRole is empty or null, the search runs with no filters. The maxRows parameter limits the number of search results returned (up to 2,147,483,647). The beginIndex parameter is used in conjunction with maxRows to partition the search results.
|
String
|
getTypeName()
Returns the name of the type.
|
Contains properties for search column.
Type | 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.
|
Search column information for returning and querying against columns.
Type | Property | Summary |
---|---|---|
String
|
displayName
|
The display name for the of the column. Optional field. Default value: null |
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
|
label
|
The label of the column that is based on the variable name in camel case characters, for example, customerName....Customer Name |
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.
|
Value types of the search column metadata.
Type | Property | Summary |
---|---|---|
String
|
Boolean
|
Searchable business data is of type Boolean |
String
|
DateTime
|
Searchable business data is of type DateTime |
String
|
Decimal
|
Searchable business data is of type Decimal |
String
|
Integer
|
Searchable business data is of type Integer |
String
|
String
|
Searchable business data is of type String |
Contains constants for searchable column names of a Process.
Type | Property | Summary |
---|---|---|
String
|
Name
|
Searching BPD instances or tasks by BPD name. |
Contains constants for searchable column names of a Process Instance.
Type | Property | Summary |
---|---|---|
String
|
CaseFolderID
|
Searching Case instances or tasks by case folder ID. |
String
|
CaseFolderServerName
|
Searching Case instances or tasks by case folder server name. |
String
|
CreateDate
|
Search BPD instances or their tasks by instance creation date. The date format is 'yyyy-MM-dd HH:mm:ss.SSS'. |
String
|
DueDate
|
Search BPD instances or their tasks by instance due date. The date format is 'yyyy-MM-dd HH:mm:ss.SSS'. |
String
|
ID
|
Searching BPD instances or tasks by instance ID. |
String
|
ModifyDate
|
Search BPD instances or their tasks by instance last modified date. The date format is 'yyyy-MM-dd HH:mm:ss.SSS'. |
String
|
Name
|
Searching BPD instances or tasks by instance name. |
String
|
ParentActivityId
|
Searching Case instances or tasks by parent activity ID. |
String
|
ParentCaseId
|
Searching Case instances or tasks by parent case ID. |
String
|
ProcessApp
|
Searching BPD instances or tasks by process application acronym. |
String
|
Snapshot
|
Searching BPD instances or tasks by snapshot name. |
String
|
StartingDocumentID
|
Searching Case instances or tasks by starting document ID. |
String
|
StartingDocumentServerName
|
Searching Case instances or tasks by starting document server name. |
String
|
Status
|
Searching BPD instances or tasks by instance status. |
String
|
WorkflowApplication
|
Searching Case instances or tasks by workflow application. |
Contains constants for searchable column names of a Task.
Type | Property | Summary |
---|---|---|
String
|
Activity
|
Search for tasks and the BPD instances that have these tasks by using the name of the activity. |
String
|
AssignedToRole
|
Search for tasks that are assigned to a role and the BPD instances that have these tasks. |
String
|
AssignedToRoleDisplayName
|
Search for tasks that are assigned to a role and the BPD instances that have these tasks by using the display name for that role. |
String
|
AssignedToUser
|
Search for tasks that are assigned to a user and the BPD instances that have these tasks. |
String
|
ClosedBy
|
Search for tasks and the BPD instances that have these tasks by who closed them. |
String
|
ClosedDate
|
Search BPD instances or their tasks by task closing date. The date format is 'yyyy-MM-dd HH:mm:ss.SSS'. |
String
|
DueDate
|
Search BPD instances or their tasks by task due date. The date format is 'yyyy-MM-dd HH:mm:ss.SSS'. |
String
|
ID
|
Search for tasks and the BPD instances that have these tasks by using their ID. |
String
|
Priority
|
Search for tasks and the BPD instances that have these tasks by using their priority. |
String
|
ReadDate
|
Search BPD instances or their tasks by task read date. The date format is 'yyyy-MM-dd HH:mm:ss.SSS'. |
String
|
ReceivedDate
|
Search BPD instances or their tasks by task received date. The date format is 'yyyy-MM-dd HH:mm:ss.SSS'. |
String
|
ReceivedFrom
|
Search BPD instances or their tasks by user ID (from which the tasks were received). |
String
|
SentDate
|
Search BPD instances or their tasks by task sent date. The date format is 'yyyy-MM-dd HH:mm:ss.SSS'. |
String
|
Status
|
Search for tasks and the BPD instances that have these tasks by using their status. |
String
|
Subject
|
Search for tasks and the BPD instances that have these tasks by using their subject text. |
Contains constants for search column types operations.
Type | 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. |
Contains properties for a search condition.
Type | 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.
|
Contains constants for search condition operations.
Type | 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. |
Used to describe data that can be used to perform searches.
Type | 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.
|
Wraps several parameters for the behavior of TWSearch into a single object.
Type | 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. |
Contains properties for search ordering.
Type | 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.
|
Contains constants for search orders operations.
Type | Property | Summary |
---|---|---|
String
|
Ascending
|
Search result is ordered ascendingly. |
String
|
Descending
|
Search result is ordered descendingly. |
Contains constants for task organized by types.
Type | Property | Summary |
---|---|---|
String
|
ProcessInstance
|
Order by process instance. |
String
|
Task
|
Order by Task. |
Search results row object.
Type | Property | Summary |
---|---|---|
TWObject[]
|
values
|
The search results row values. |
Method Summary | |
---|---|
String
|
getTypeName()
Returns the name of the type.
|
Search results object.
Type | 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.
|
Represents an executable service.
Type | 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.
|
Constants to represent types of services.
Type | Property | Summary |
---|---|---|
String
|
Ajax
|
Service that can be used in Coach controls that support asynchronous server calls using Ajax. |
String
|
ExternalService
|
External service that is used to invoke a REST service, Web service, or Java method. |
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. |
String
|
ServiceFlow
|
Service flow that can be edited in the web Process Designer. |
Contains useful methods to access the Task.
Type | Property | Summary |
---|---|---|
TWDate
|
activationTime
|
The date and time that the task was received. |
TWObject
|
assignedTo
|
The TWUser or TWRole that the task is currently assigned to. |
TWDate
|
atRiskDate
|
The date when an incomplete task has taken longer than average amount of time; the task is considered at risk. |
TWDate
|
completionTime
|
The time at which the task was completed. |
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 person who originated the task. |
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 that is associated with the task |
String
|
processActivityName
|
The name of the process activity that is associated with the task |
String
|
processActivityRichDescription
|
The description of the process activity that is associated with the task in rich text format |
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 | |
---|---|
boolean
|
claim()
Claims the task as the current user. Returns "true" if the claim was successful, "false" otherwise.
|
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
|
decisionRecommendation(String
decisionVariable
,
Map
data)
(Non-Production) Predicts the value of the given decision variable using the aggregate historic decisions leading to the current one instance. Returns the predicted value with explanations, along with the prediction confidence.
|
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 specified users, roles, or teams and accepts a single string that can be comma delimited. The users, roles, or teams are matched by username, role name, or team name. Roles are matched only if they are prefixed by "ROLE:". Teams are matched only if they are prefixed by "TEAM:" or "PG:". Usernames don't need to be prefixed by "USER:", but they 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 TWParticipantGroup, for instance.
|
void
|
reassignTo(String[]
usersOrRoles)
Reassigns the task to the specified users, roles, or teams and accepts a TW list of strings. The users, roles, or teams are matched by username, role name, or team name. Roles are matched only if they are prefixed by "ROLE:". Teams are matched only if they are prefixed by "TEAM:" or "PG:". Usernames don't need to be prefixed by "USER:", but they can be.
|
void
|
start(TWUser
user)
Starts the task with the given user. This effectively just sets the start time of the task.
|
Contains constants for priority types.
Type | Property | Summary |
---|---|---|
String
|
High
|
High Priority. |
String
|
Highest
|
Highest Priority. |
String
|
Low
|
Low Priority. |
String
|
Lowest
|
Lowest Priority. |
String
|
Normal
|
Normal Priority. |
Contains constant values for possible statuses.
Type | 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. |
Contains useful methods of team.
Type | 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 to the team. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
void
|
addUsers(TWUser
users)
Add users to the team. With IBM BPM V8.5.7 cumulative 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
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 roles from the team. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
void
|
removeUsers(TWUser
users)
Remove the users from the team. With IBM BPM V8.5.7 cumulative fix 2016.09 installed, group membership updates are more restrictive. See the group membership update REST API documentation for more details.
|
void
|
setAutomaticRefresh(boolean
enable)
Sets the enable-automatic-refresh flag for this team.
|
void
|
setManagerTeam(String
teamName)
Sets the manager team for this team.
|
IBM Business Automation Workflow Variable Type that describes a time period (e.g. 7AM-7PM M-F). Note that start and end time are not allowed to have the same value. Otherwise the time period will be ignored as its duration is effectively 0.
Type | Property | Summary |
---|---|---|
Time
|
endTime
|
The ending time of the day (23:59 for midnight end of day) |
Boolean
|
friday
|
Whether or not this period is in effect for Friday (e.g. Friday is a work day) |
String
|
id
|
The ID of the time period instance. |
Boolean
|
monday
|
Whether or not this period is in effect for Monday (e.g. Monday is a work day) |
Boolean
|
saturday
|
Whether or not this period is in effect for Saturday (e.g. Saturday is a work day) |
Time
|
startTime
|
The starting time of the day (00:00 for midnight start of day) |
Boolean
|
sunday
|
Whether or not this period is in effect for Sunday (e.g. Sunday is a work day) |
Boolean
|
thursday
|
Whether or not this period is in effect for Thursday (e.g. Thursday is a work day) |
Boolean
|
tuesday
|
Whether or not this period is in effect for Tuesday (e.g. Tuesday is a work day) |
Boolean
|
wednesday
|
Whether or not this period is in effect for Wednesday (e.g. Wednesday is a work day) |
An instance of a timer waiting.
Type | Property | Summary |
---|---|---|
String
|
id
|
The instance ID of the timer. |
Method Summary | |
---|---|
String
|
getTypeName()
Returns the name of the type.
|
IBM Business Automation Workflow Variable Type that describes a time schedule (e.g. 24x7) that covers the period to be used for SLAs
Type | Property | Summary |
---|---|---|
Boolean
|
excludeHolidays
|
Whether or not this time schedule excludes holidays. If so, a valid Holiday Schedule should be defined and selected for the activity or BPD. |
String
|
id
|
The ID of the time schedule |
String
|
name
|
The name of the time schedule |
TWTimePeriod[]
|
periods
|
A list of time periods that make up the time schedule. If more than one period is defined per day (e.g. 8A-12P M-F and 1P-5P M-F), all periods are unioned to come up with the full schedule coverage |
Contains useful methods to access the User.
Type | 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. |
boolean
|
isActive
|
Returns the user state; a user can be active or inactive. |
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. |
TWObject*TWTeam
|
teams
|
Returns all the teams that the user is a member of. It searches in the Process App/Toolkit where the JavaScript is specified. |
Method Summary | |
---|---|
Map
|
getAttributes()
Deprecated. use property attributesReturns all the user's attributes. |
String
|
getFullName()
Deprecated. use property fullNameReturns a user's full name. |
int
|
getId()
Deprecated. use property idReturns a user's Id. |
TWUserLocalePreferences
|
getLocalePreferences(TWUser
user)
Sets the locale preferences for a user.
|
String
|
getName()
Deprecated. use property nameReturns a user's name. |
TWRole
|
getPrimaryRole()
Deprecated. use property parimaryRoleReturns the primary role of the user. |
TWRole
|
getPrimaryRoleParent()
Deprecated. use property primaryRoleParentReturns the parent of the primary role of the user. |
TWRole[]
|
getRoles()
Deprecated. use property rolesReturns 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
| TWRole
role)
Tells if the user is a member of the Role. Where role can be either be a TWRole object, or the string name of a 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.
|
Holds information about a user's locale preferences.
Type | Property | Summary |
---|---|---|
String
|
locale
|
Holds a locale in standard format: |
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. |
Transient IBM Business Automation Workflow Variable Type that contains a Time Schedule, Timezone, and Holiday Schedule
Type | Property | Summary |
---|---|---|
TWHolidaySchedule
|
holidaySchedule
|
The holiday schedule |
TWTimeSchedule
|
timeSchedule
|
The time schedule |
String
|
timeZone
|
The time zone |
URL Type
Dashboard coach views support.
Method Summary | |
---|---|
TeamMemberTaskSummary
|
retrieveTeamMemberSummary( String
filterString
,
String
timeZoneAsString)
Retrieves task status summary counts for a User.
|
The user information.
Type | 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. |
This class represents XML Document in IBM Business Automation Workflow. Use this class to indicate that a variable is 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 string 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.
|
This class represents XML Element in IBM Business Automation Workflow. Use this class to indicate that a variable is XML Element
Type | 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 string 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.
|
This class represents XML Node List in IBM Business Automation Workflow. Use this class to indicate that a variable is XML Node List
Type | Property | Summary |
---|---|---|
int
|
length
|
The number of items in the list. |
Method Summary | |
---|---|
XMLElement
|
item(Integer
index)
The item at position index.
|
The 'tw.perf' object used in a process context contains runtime data from the Performance Server.
Type | Property | Summary |
---|---|---|
TWSLANamespace
|
sla
|
Deprecated. TWSLANamespace is deprecated. The sla namespace contains runtime Service Level Agreement statistics. |
The 'tw.system.bpd' object used in a process context contains useful variables and constants about the system and the particular process instance.
Type | Property | Summary |
---|---|---|
TWObject*ConditionalActivity
|
conditionalActivities
|
Hierarchical list of conditional activities in current BPD. |
TWDate
|
dueDate
|
The due date of the instance. Can be null and can be set. |
String
|
guid
|
The GUID of this business process. |
String
|
id
|
The ID of this business process. |
String
|
instanceId
|
The unique Id of this particular instance. |
String
|
name
|
The name of this particular instance. |
String[]
|
selectedConditionalActivities
|
List of Conditional Activities that have been selected. Can be null and can be set. |
Namespace for accessing and manipulating system data from a process context using 'tw.system'. It contains useful variables and constants about the system and the particular process instance.
Type | Property | Summary |
---|---|---|
ActivityInstance
|
currentAdHocActivityInstance
|
The enclosing activity instance, if any. |
TWProcess
|
currentProcess
|
Get the Current Process. |
TWProcessInstance
|
currentProcessInstance
|
Get the Current Process Instance. |
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. |
CaseReference
|
enclosingCaseInstance
|
Case instance that originated on the IBM Case Manager server. |
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
|
The system namespace containing access to the model objects. |
TWBPDSystemOrgNamespace
|
org
|
The system namespace containing access to the user organization. |
TWBPDSystemBPDNamespace
|
process
|
The system namespace containing system bpd constants. |
Serializer
|
serializer
|
Deprecated. Serialization format is internal. The serializer namespace containing object serializer. |
TWProcessStepInfo
|
step
|
The system namespace containing system step constants. |
TWTimeSchedule[]
|
timeSchedules
|
The system namespace containing access to all time schedules. |
TWUser
|
user
|
The system namespace containing access to the current User. |
Method Summary | |
---|---|
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
|
assignNextTask(String
groupId
,
String
sortCriteria
,
Boolean
enabledRetryOptimization
,
String
userId)
Based on the groupId and sortCriteria, assign the next task to the user identified by the userId.
|
String
|
assignNextTaskByTeamName(String
teamName
,
String
sortCriteria
,
Integer
optimizationLevel
,
Boolean
includeAllSnapshotTasks
,
String
userId)
Based on the teamName and sortCriteria parameters, assign the next task to the user identified by the userId.
|
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)
Calculates 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. For example, if the original date falls on a Saturday or Sunday, the delta is -1 day, and the work schedule is set to Monday through Friday, 9 AM to 5 PM without a set holiday schedule, the calculated date will be Friday, 9:00 AM. If the delta is 1 day, the resulting date will be Tuesday, 9:00 AM. In a forward calculation, 1 business day is skipped whereas when going backward, the beginning of the business day is returned.
|
void
|
cancelStep(Integer
stepId)
Reschedules a timer.
|
String
|
convertIDToDB(String
id)
Convert a typed external id to an id suitable for use in a database query.
|
String
|
createCase(String
caseType
,
String
objectStoreName
,
Record
caseProperties
,
String[]
caseStructure
,
String[]
asAdministrator)
Creates a new instance of a case for the specified case type. Returns the ID of the new case.
For more information, see Formats of case property values and Interacting with cases and activities from processes or service flows. |
variableTypeName[]
|
createFromSql(String
variableTypeName
,
String
jndiName
,
String
sqlQuery
,
ANY
params)
Returns a list of objects for the specified variable type name. The objects contain the result of the SQL query.
|
void
|
createFromXmlElement(String
variableTypeName
,
Element
xml)
Returns an array of {variableTypeName} objects containing the data in the given XMLified recordset.
|
BPMFailedOperation[]
|
deleteAlertDefinitions(String[]
ids
,
Boolean
checkAuthorization)
Deletes alert definitions based on the given list of IDs.
|
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.
|
Map
|
executeServiceByName(String
name
,
Map
inputValues)
Start the Service with the given name.
|
ActivityInstance
|
findActivityInstanceByID(String
activityId)
Returns the activity instance found by Id.
|
TWDocument
|
findDocumentByID(String
documentId)
Returns the document found by identifier.
|
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'.
|
BPMAlertDefinition[]
|
getAlertDefinitions( String[]
categoryFilter
,
Boolean
checkAuthorization)
Returns a list of alert definitions.
|
BPMAlertDefinitionStatusResponse
|
getAlertDefinitionsStatus(String[]
ids
,
Boolean
checkAuthorization)
Returns the current run time values for the list of alert definitions specified, including the actual values and whether the conditions were met.
|
String
|
getEnvironmentVariableValue(String
processAppAcronym
,
String
snapshotAcronym
,
String
environmentVariableName)
Returns the current value for the specified environment variable in context of the specified process application snapshot.
|
boolean
|
removeHolidaySchedule(String
id)
Removes 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.
|
InstanceListData
|
retrieveInstanceList(InstanceListProperties
properties
,
Integer
maxRows
,
Integer
beginIndex
,
Boolean
checkAuthorization)
Deprecated. The retrieveInstanceList method is deprecated in container environments. There is currently no replacement.Returns a list of instances according to the given properties. |
ProcessSummary[]
|
retrieveProcessSummaries( String
searchFilter
,
Boolean
checkAuthorization)
Returns a list of process summary counts for all active/deployed processes across projects.
|
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 based on the authorization of the current user.
|
TeamTaskSummary[]
|
retrieveTeamSummaries( String
searchFilter
,
String
timeZoneAsString
,
Boolean
checkAuthorization)
Retrieve summary count data of the active tasks of all the Teams.
|
BPMAlertDefinition[]
|
saveAlertDefinitions(BPMAlertDefinition[]
definitions
,
Boolean
importMode
,
Boolean
checkAuthorization)
Saves the list of alert definitions in the database.
|
String
|
sortByNextBestTask(String
taskList
,
String
workerId)
Sorts the task list for the given worker ID to show the next task the worker with that ID should work on based on his or her skill set and what will have the most impact. The resulting task list is sorted and returned without modifying the objects that are already in the list. The API returns null if a connection to the AI Agent Server can't be established. In this case, errors are recorded in the system log.
|
TWProcessInstance
|
startProcessByName(String
name
,
Map
inputValues
,
Boolean
checkAuthorization)
Start the BPD with the given name.
|
void
|
touchVariable(String
name)
Update the modification time for a variable in the 'tw.local' namespace.\nThis can be used to manually update the modification time for a complex object\nafter its property values have been modified, since this does not occur automatically.
|
String
|
trainDecisionRecommendation(String
activityName
,
String
processName
,
String
decisionVariable)
(Non-Production) Trains the decision recommendation model for a specific activity in a process.
|
void
|
trainNextBestTask()
Refreshes the task prioritization models by using the latest data in Business Automation Insights.
|
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
|
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 Business Automation Workflow variable type associated with a variable.
|
The 'tw.system.org' object used in a process context contains useful methods to access the user organization.
Type | Property | Summary |
---|---|---|
PGNamespace
|
pg
|
Deprecated. tw.system.org.pg is deprecated. Use tw.system.org.team instead. The pg namespace contains all participant groups of the model. |
TeamNamespace
|
team
|
The team namespace contains all teams of the model. |
Method Summary | |
---|---|
TWRole
|
createRole(String
roleName
,
String
roleDisplayName
,
String
roleDescription
,
Boolean
checkAuthorization)
Creates a new role.
|
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
participantName)
Finds a team given its name.
|
TWRole
|
findRoleById(Integer
roleId)
Finds a role given their Id.
|
TWRole
|
findRoleByName(String
roleName)
Finds a role given their name.
|
TWTeam
|
findTeam(String
teamId
,
String
processAppId)
The second parameter is optional. If the second parameter is passed, this method searches in the corresponding process app or toolkit for a team with the specified teamId. If the second parameter is omitted or is null, all process apps and toolkits are searched. First, the search occurs in the default snapshot (including its dependency hierarchy), then in the latest snapshot N (including its dependency hierarchy), then in the next-to-latest (=N-1) snapshot (including its dependency hierarchy), and so on. The first team that matches the teamId is returned.
|
TWTeam
|
findTeamByID(String
teamId)
This method searches in the current context for a team that has the specified teamId. The context of the caller depends on whether the search occurs in a process app or toolkit and on the corresponding snapshot the caller is in. If the teamId is not found in the process app or toolkit, the dependency hierarchy is searched. The first team that matches the teamId is returned.
|
TWTeam
|
findTeamByName(String
teamName)
This method searches in the current context, which is the context of the caller, for a team with the specified teamName. The teamName is specified in Process Designer. If the caller is in the context of a snapshot, only this snapshot context is searched. This method searches for a team with the specified teamName, If the team is not found, "null" is returned.
|
TWUser
|
findUserById(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 in the system.
|
TWTeam[]
|
getAllTeams()
Returns all Teams.
|
TWUser[]
|
getAllUsers()
Returns all users in the system.
|
TWRole[]
|
getUMSSubTeams(String
roleName
,
Boolean
deep
,
Boolean
sync)
Returns the UMS teams that are children of the input UMS team.
|
void
|
removeRole(String
roleName
,
Boolean
checkAuthorization)
Delete an internal group. Note: You can't delete a group that has tasks assigned or is configured as bpmAdminGroup in the BPMServerSecurityGroups configuration.
|
Namespace for accessing and manipulating environment variables.
Method Summary | |
---|---|
void
|
update(TWEnvironmentVariable
envVar
,
String
value
,
Boolean
withRespectToToolkit)
Update the value of an environment variable.
|
String
|
variableValue(String
envVarName
,
String
toolkitName)
Returns the value for the specified environment variable name.
|
An instance of a help request.
Type | Property | Summary |
---|---|---|
String
|
id
|
Returns the read-only identifier (externalized ID) of a 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.
|
The 'tw.system.install' object contains useful variables and methods about the installation history.
Type | Property | Summary |
---|---|---|
TWProcessAppSnapshot[]
|
snapshotsMigratingInstances
|
A JavaScript array of Snapshots that are having their instances Migrated. |
String
|
status
|
Accesses the Installation status. |
TWInstallStatusesNamespace
|
Statuses
|
The installation 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.
|
The 'tw.system.install.Statuses' object contains the constant values for the possible statuses.
Type | 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. |
The object namespace is used to initialize complex objects in IBM Business Automation Workflow.
Type | Property | Summary |
---|---|---|
TWContentObjectNamespace
|
contentObject
|
The content object namespace is used to initialize content objects. |
TWPropertyNamespace
|
property
|
The property namespace is used to initialize content object properties. |
TWToolkitNamespace
|
toolkit
|
The toolkit namespace is used to designate the toolkit that contains the complex object to initialize in IBM Business Automation Workflow. |
The 'tw.system.org' object contains useful methods to access the User Organization.
Type | 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
|
Deprecated. TWSLANamespace is deprecated. The sla namespace contains runtime Service Level Agreement statistics. |
TeamNamespace
|
team
|
The pg namespace contains all teams. |
Method Summary | |
---|---|
TWRole
|
createRole(String
roleName
,
String
roleDisplayName
,
String
roleDescription
,
Boolean
checkAuthorization)
Creates a new role.
|
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.
|
TWRole[]
|
getUMSSubTeams(String
roleName
,
Boolean
deep
,
Boolean
sync)
Returns the UMS teams that are children of the input UMS team.
|
void
|
removeRole(String
roleName
,
Boolean
checkAuthorization)
Delete an IBM Business Automation Workflow security group. Note: You can't delete a group that has tasks assigned or is configured as bpmAdminGroup in the BPMServerSecurityGroups configuration.
|
An instance of a help request.
Type | 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.
|
The 'tw.system.install' object contains useful variables and methods about the installation history.
Type | 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.
|
The 'tw.system.install.Statuses' object contains the constant values for the possible statuses.
Type | 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. |
The 'tw.perf' object contains runtime data from the Performance Server. Deprecated.
Type | Property | Summary |
---|---|---|
TWSLANamespace
|
sla
|
Deprecated. TWSLANamespace is deprecated. The sla namespace contains runtime Service Level Agreement statistics |
The TW Object which is the wrapper around all variables in the system.
Type | 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. |
Namespace for accessing and manipulating system data from a service context using 'tw.system'. It contains useful variables and constants about the system and the particular service instance.
Type | Property | Summary |
---|---|---|
String
|
buttonPressed
|
Value of the Coach button pressed expression |
CoachValidation
|
coachValidation
|
Coach validation object |
ActivityInstance
|
currentAdHocActivityInstance
|
The current ad-hoc activity instance being executed, if any. |
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 Business Automation Workflow variables. |
TWService
|
serviceFlow
|
Get the service flow. |
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
|
assignNextTask(String
groupId
,
String
sortCriteria
,
Boolean
enabledRetryOptimization
,
String
userId)
Description N/A
|
String
|
assignNextTaskByTeamName(String
teamName
,
String
sortCriteria
,
Integer
optimizationLevel
,
Boolean
includeAllSnapshotTasks
,
String
userId)
Description N/A
|
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)
Calculates 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. For example, if the original date falls on a Saturday or Sunday, the delta is -1 day, and the work schedule is set to Monday through Friday, 9 AM to 5 PM without a set holiday schedule, the calculated date will be Friday, 9:00 AM. If the delta is 1 day, the resulting date will be Tuesday, 9:00 AM. In a forward calculation, 1 business day is skipped whereas when going backward, the beginning of the business day is returned.
|
void
|
clearCoachValidationErrors(CoachValidation
coachValidation)
Clears all coach validation errors.
|
void
|
clearError()
Clear error variable tw.system.error
|
String
|
convertIDToDB(String
id)
Convert a typed external ID to an ID suitable for use in a database query
|
String
|
createCase(String
caseType
,
String
objectStoreName
,
Record
caseProperties
,
String[]
caseStructure
,
String[]
asAdministrator)
Description N/A
|
variableTypeName[]
|
createFromSql(String
variableTypeName
,
String
jndiName
,
String
sqlQuery
,
ANY
params)
Returns a list of objects for the specified variable type name. The objects contain the result of the SQL query.
|
void
|
createFromXmlElement(String
variableTypeName
,
Element
xml)
Returns an array of {variableTypeName} objects containing the data in the given XMLified recordset.
|
BPMFailedOperation[]
|
deleteAlertDefinitions(String[]
ids
,
Boolean
checkAuthorization)
Deletes alert definitions based on the given list of IDs.
|
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.
|
Map
|
executeServiceByName(String
name
,
Map
inputValues)
Start the Service with the given name.
|
ActivityInstance
|
findActivityInstanceByID(String
activityId)
Returns the activity instance found by Id.
|
TWDocument
|
findDocumentByID(String
documentId)
Returns the document found by identifier.
|
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'.
|
BPMAlertDefinition[]
|
getAlertDefinitions( String[]
categoryFilter
,
Boolean
checkAuthorization)
Returns a list of alert definitions.
|
BPMAlertDefinitionStatusResponse
|
getAlertDefinitionsStatus(String[]
ids
,
Boolean
checkAuthorization)
Returns the current run time values for the list of alert definitions specified, including the actual values and whether the conditions were met.
|
String
|
getCaseCalendarEvents(String
caseId
,
String
objectStoreName
,
String
asAdministrator)
Gets the calendar events for a case.
|
String
|
getCaseConfiguration(String
caseId
,
String
objectStoreName
,
String
asAdministrator)
Gets the configuration for a case type.
|
String
|
getEnvironmentVariableValue(String
processAppAcronym
,
String
snapshotAcronym
,
String
environmentVariableName)
Returns the current value for the specified environment variable in context of the specified process application snapshot.
|
BPMRESTResponse
|
invokeREST(BPMRESTRequest
request)
Function to invoke an external service with REST binding.
|
void
|
populateCoachValidationFromBOSaveFailedError(CoachValidation
coachValidation
,
BPMBOSaveFailedError
boSaveFailedError)
Populates a CoachValidation instance with the validation errors from a BOSaveFailedError instance.
|
void
|
reassignTask(Integer
taskId
,
String
reassignTo
,
ANY
resetTask)
Deprecated. reassignTask() has been Deprecated. Use the reassignTo() function in TWTask insteadReassigns 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'.
|
InstanceListData
|
retrieveInstanceList(InstanceListProperties
properties
,
Integer
maxRows
,
Integer
beginIndex
,
Boolean
checkAuthorization)
Deprecated. The retrieveInstanceList method is deprecated in container environments. There is currently no replacement.Returns a list of instances according to the given properties. |
ProcessSummary[]
|
retrieveProcessSummaries( String
searchFilter
,
Boolean
checkAuthorization)
Returns a list of process summary counts for all active/deployed processes across projects.
|
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 count data of the active tasks of all the Teams.
|
BPMAlertDefinition[]
|
saveAlertDefinitions(BPMAlertDefinition[]
definitions
,
Boolean
importMode
,
Boolean
checkAuthorization)
Saves the list of alert definitions in the database.
|
String
|
sortByNextBestTask(String
taskList
,
String
workerId)
Sorts the task list for the given worker ID to show the next task the worker with that ID should work on based on his or her skill set and what will have the most impact. The resulting task list is sorted and returned without modifying the objects that are already in the list. The API returns null if a connection to the AI Agent Server can't be established. In this case, errors are recorded in the system log.
|
TWProcessInstance
|
startProcessByName(String
name
,
Map
inputValues
,
Boolean
checkAuthorization)
Start the BPD with the given name.
|
String
|
toString()
Returns String representation of the namespace
|
String
|
trainDecisionRecommendation(String
activityName
,
String
processName
,
String
decisionVariable)
(Non-Production) Trains the decision recommendation model for a specific activity in a process.
|
void
|
trainNextBestTask()
Refreshes the task prioritization models by using the latest data in Business Automation Insights.
|
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.
|
void
|
updateCurrentInstanceVariablesByCurrentTaskOwner(Object
values
,
Boolean
isTopLevel)
Updates the current instance variables by current task owner.
|
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 Business Automation Workflow variable type associated with a variable
|