ActionItem Class Properties

In this section, the ActionItem class properties are presented in alphabetical order.

Description

Use this property to set or return a string value representing the name of the application class that contains the ItemPostProcess method to be invoked for post-processing of this action item.

Note: The full path to the ItemPostProcess method is constructed from three properties: PackageRoot, QualifyPath, and AppClassID

This property is read-write.

Description

Use this property to set or return a string value representing the user ID or role to which this action item has been assigned.

Note: While you can specify any user ID or role, only a user or role that has also been assigned Contributor privileges on the template or instance Security page will be allowed to complete the action item. The system will not validate your selection against the users or roles defined on the Security page.

This property is read-write.

Description

Use this property to set or return a string value representing the participant type (user or role) for this action item.

This property is read-write.

Description

Use this property to set or return a Boolean value indicating whether the current step is the active step currently being worked in the activity guide.

This property is read-write.

Description

Use this property to set or return the description for the action item as a string value.

This property is read-write.

Description

Use this property to set or return a Date value representing the date portion of the due date and time.

This property is read-write.

Description

Use this property to set or return a Time value representing the time portion of the due date and time.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the first configurable text field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the fifth configurable yes/no field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the second configurable text field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the third configurable text field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the fourth configurable text field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the fifth configurable text field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the first configurable yes/no field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the second configurable yes/no field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the third configurable yes/no field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to set or return a string value representing the application data for the fourth configurable yes/no field to be used in execution of the transaction.

This property is read-write.

Description

Use this property to return a string representing the ID for this action item.

This property is read-only.

Description

Use this property to set or return a string representing the descriptive name (or title) of the action item.

This property is read-write.

Description

Use this property to set or return a string value representing the ID for the activity guide containing the current action item.

This property is read-write.

Description

Use this property to set or return a string value representing the name of the application package that contains the ItemPostProcess method to be invoked for post-processing of this action item.

Note: The full path to the ItemPostProcess method is constructed from three properties: PackageRoot, QualifyPath, and AppClassID

This property is read-write.

Description

Use this property to set or return the ID of the summary (or parent) action item. If there is no parent action item, the value returned is ROOT.

This property is read-write.

Description

Use this property to set or return a Number value indicating the percentage completion for this action item.

This property is read-write.

Description

Use this property to set or return a string value representing the priority for this action item. The valid values are:

Value

Description

1

Low

2

Medium

3

High

This property is read-write.

Description

Use this property to set or return a string value representing the names of each subpackage in the application class hierarchy that define the location of the application class. Separate subpackage names by a colon. If the class is defined in the top-level application package, use a colon only.

Note: The full path to the ItemPostProcess method is constructed from three properties: PackageRoot, QualifyPath, and AppClassID

This property is read-write.

Description

Use this property to set or return the progress remarks for this action item.

This property is read-write.

Description

Use this property to set or return a Boolean value indicating whether the action item is required.

This property is read-write.

Description

Use this property to set or return a Number value representing the sequence number for the action item.

This property is read-write.

Description

Use this property to set or return a string value representing the ID for the related content service that will be executed when the user clicks this action item in the activity guide pagelet.

This property is read-write.

Description

Use this property to set or return a Date value representing the date portion of the start date and time.

This property is read-write.

Description

Use this property to set or return a Time value representing the time portion of the start date and time.

This property is read-write.

Description

Use this property to set or return a string value representing the status of the current action item. Valid values are:

Value

Description

0

Not assigned

1

Assigned

2

In progress

3

On hold

4

Completed

5

Cancelled

This property is read-write.

Description

Use this property to set or return a Boolean value indicating whether the action item is a summary action item. When this property is False, the action item is a detail action item.

This property is read-write.

Description

Use this property to set or return a string value representing the type of the related content service that will be executed when the user clicks this action item in the activity guide pagelet. The valid values are:

Value

Description

A

Application class URL

C

PeopleSoft component

N

Non-PeopleSoft URL

Q

PeopleSoft query

S

PeopleSoft script

This property is read-write.