Open topic with navigation

TIBCO Business Studio™ - BPM Edition 5.4.0

# WorkItem

This table lists the WorkItem attributes and methods provided.

Attribute / Method | Comments
--- | ---
WorkItem |
cancel : Boolean | Cancels an API that exists in BRM.
description : Text | The description of the work item.
priority : Number | The specified priority of the work item.
getId() : Number | Returns the work item’s unique ID.
getVersion() : Number | Returns the version number of the work item.
getWorkItemResource() : EntityDetail | Returns a resource that has this work item. It contains all the organizational entities whose work list currently contains this work item.
getWorkItemOffers() : List<EntityDetail> | Returns a work item resource object for the work item. If the item was originally offered to more than one organizational entity and is now allocated, this contains all the entities to which the item was originally offered.
getContext() : ItemContext | Returns the work item's context information and provides read only methods to access the following information: activity ID activity name application name application instance application ID application instance description
getSchedule() : ItemSchedule | Returns the work item's schedule information and provides read only methods to access the start date and target date.
workItemAttributes.attribute1: Number | These work item attributes (attribute1 and the others listed below) can be used to contain data associated with a work item and to sort and filter your work list. They are available where the WorkManager object can be accessed (for example, on a user task schedule script). For example, attribute2 can be used to hold a customer name, and attribute1 a customer reference number to aid work list sort and filter choices. The attribute1 work item attribute can be assigned integer values in the range -2,147,483,648 to 2,147,483,647.
workItemAttributes.attribute2: Text workItemAttributes.attribute3: Text workItemAttributes.attribute4: Text | Limited to 64 characters in length. See description above.
workItemAttributes.attribute5: Number | See description above. This can be assigned Decimal or BigDecimal values.
workItemAttributes.attribute6: Date | See description above.
workItemAttributes.attribute7: Date | See description above.
workItemAttributes.attribute8: Text workItemAttributes.attribute9: Text workItemAttributes.attribute10: Text workItemAttributes.attribute11: Text workItemAttributes.attribute12: Text workItemAttributes.attribute13: Text workItemAttributes.attribute14: Text | Limited to a maximum of 20 characters - anything larger is truncated. See description above.
workItemAttributes.attribute15: Number | The attribute15 work item attribute can be assigned integer values in the range -2,147,483,648 to 2,147,483,647.
workItemAttributes.attribute16: Number | See description above. This can be assigned Decimal or BigDecimal values.
workItemAttributes.attribute17: Number | See description above. This can be assigned Decimal or BigDecimal values.
workItemAttributes.attribute18: Number | See description above. This can be assigned Decimal or BigDecimal values.
workItemAttributes.attribute19: Date | See description above.
workItemAttributes.attribute20: Date | See description above.
workItemAttributes.attribute21: Text workItemAttributes.attribute22: Text workItemAttributes.attribute23: Text workItemAttributes.attribute24: Text workItemAttributes.attribute25: Text workItemAttributes.attribute26: Text | Limited to a maximum of 20 characters - anything larger is truncated. See description above.
workItemAttributes.attribute27: Text workItemAttributes.attribute28: Text workItemAttributes.attribute29: Text workItemAttributes.attribute30: Text workItemAttributes.attribute31: Text workItemAttributes.attribute32: Text workItemAttributes.attribute33: Text workItemAttributes.attribute34: Text workItemAttributes.attribute35: Text workItemAttributes.attribute36: Text workItemAttributes.attribute37: Text workItemAttributes.attribute38: Text | Limited to a maximum of 64 characters - anything larger is truncated. See description above.
workItemAttributes.attribute39: Text workItemAttributes.attribute40: Text | Limited to a maximum of 255 characters - anything larger is truncated. See description above.
ItemContext |
getActivityId() : Text |
getActivityName() : Text |
getAppName() : Text |
getAppInstance() : Text |
getAppId() : Text |
getAppInstanceDescription() : Text |
ItemSchedule |
getStartDate() : Date |
getTargetDate : Date |

Note: When using `getWorkItem()` or `getSchedule()`, note that the following object is displayed:

- A null object when there is a null value.
- An empty object, "", when there is a 0 length value.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO Business Studio™ - BPM Edition

Copyright © 2015-2023. Cloud Software Group, Inc. All Rights Reserved.